@atlaskit/editor-common 74.20.0 → 74.21.1

package/dist/esm/i18n/zh.js

@@ -13,9 +13,13 @@ export default {
   'fabric.editor.alignImageCenter': '居中',
   'fabric.editor.alignImageLeft': '左对齐',
   'fabric.editor.alignImageRight': '右对齐',
+  'fabric.editor.blockCardUnavailable': '内联链接位于 {node} 内部，无法更改其视图',
+  'fabric.editor.blockDescription': '显示有关链接的更多信息，包括摘要和操作',
+  'fabric.editor.blockTitle': '卡片',
   'fabric.editor.blockquote': '引用',
   'fabric.editor.cancelButton': '取消',
   'fabric.editor.captionPlaceholder': '添加标题',
+  'fabric.editor.cardFloatingControls': '卡片选项',
   'fabric.editor.codeBidiWarningLabel': '双向字符会更改文本的呈现顺序。这可能被用于掩盖恶意代码。',
   'fabric.editor.codeBlockCopyButton.copiedToClipboard': '已复制！',
   'fabric.editor.codeBlockCopyButton.copyToClipboard': '复制为文本',
@@ -30,8 +34,16 @@ export default {
   'fabric.editor.date.description': '使用日历添加日期',
   'fabric.editor.decision': '决定',
   'fabric.editor.decision.description': '捕获决策，以便轻松跟踪',
+  'fabric.editor.displayBlock': '显示卡片',
+  'fabric.editor.displayEmbed': '显示嵌入',
+  'fabric.editor.displayInline': '显示内联',
+  'fabric.editor.displayLink': '显示为文本',
+  'fabric.editor.displayOptionUnavailableInParentNode': '无法在 {node} 内使用此显示选项',
+  'fabric.editor.ecombedDescription': '显示链接的交互式预览',
+  'fabric.editor.edit.datasource': '编辑搜索查询',
   'fabric.editor.editLink': '编辑链接',
   'fabric.editor.editMode.inviteToEditButton.title': '邀请编辑',
+  'fabric.editor.embedTitle': '嵌入',
   'fabric.editor.emoji': '表情符号',
   'fabric.editor.emoji.description': '使用表情符号传达理念 🎉 和情绪 😄',
   'fabric.editor.emptyLink': '请输入链接。',
@@ -48,6 +60,8 @@ export default {
   'fabric.editor.horizontalRule.description': '使用水平线分隔内容',
   'fabric.editor.hyperlinkToolbarPlaceholder': '粘贴或搜索链接',
   'fabric.editor.image': '图片',
+  'fabric.editor.inlineDescription': '以内联文本显示链接',
+  'fabric.editor.inlineTitle': '内联',
   'fabric.editor.insertMenu': '插入',
   'fabric.editor.invalidLink': '请输入有效链接。',
   'fabric.editor.layoutFixedWidth': '返回至中心',
@@ -87,6 +101,9 @@ export default {
   'fabric.editor.unsupportedBlockContent': '此编辑器不支持显示此内容',
   'fabric.editor.unsupportedContentTooltip': '此编辑器中的内容不可用，在编辑和保存时将保留此内容',
   'fabric.editor.unsupportedInlineContent': '内容不受支持',
+  'fabric.editor.url': '显示 URL',
+  'fabric.editor.urlDescription': '以 URL 显示链接',
+  'fabric.editor.urlTitle': 'URL',
   'fabric.editor.viewMore': '查看更多',
   'fabric.editor.visit': '在新窗口中打开链接',
   'fabric.editor.wrapLeft': '隐藏左边',

package/dist/esm/i18n/zh_TW.js

@@ -13,9 +13,13 @@ export default {
   'fabric.editor.alignImageCenter': '置中對齊',
   'fabric.editor.alignImageLeft': '靠左對齊',
   'fabric.editor.alignImageRight': '靠右對齊',
+  'fabric.editor.blockCardUnavailable': '內嵌連結位於 {node} 內，無法變更其檢視',
+  'fabric.editor.blockDescription': '顯示有關連結的更多資訊，包括摘要和動作',
+  'fabric.editor.blockTitle': '卡片',
   'fabric.editor.blockquote': '引述',
   'fabric.editor.cancelButton': '取消',
   'fabric.editor.captionPlaceholder': '新增標題',
+  'fabric.editor.cardFloatingControls': '卡片選項',
   'fabric.editor.codeBidiWarningLabel': '雙向字元會變更文字呈現的順序。這可用來將惡意程式碼模糊化。',
   'fabric.editor.codeBlockCopyButton.copiedToClipboard': '已複製！',
   'fabric.editor.codeBlockCopyButton.copyToClipboard': '複製文字',
@@ -30,8 +34,16 @@ export default {
   'fabric.editor.date.description': '使用日曆新增日期',
   'fabric.editor.decision': '決定',
   'fabric.editor.decision.description': '擷取決定以便追蹤',
+  'fabric.editor.displayBlock': '顯示卡片',
+  'fabric.editor.displayEmbed': '顯示嵌入',
+  'fabric.editor.displayInline': '顯示內嵌',
+  'fabric.editor.displayLink': '以文字顯示',
+  'fabric.editor.displayOptionUnavailableInParentNode': '{node} 內無法使用此顯示選項',
+  'fabric.editor.ecombedDescription': '顯示連結的互動式預覽',
+  'fabric.editor.edit.datasource': '編輯搜尋查詢',
   'fabric.editor.editLink': '編輯連結',
   'fabric.editor.editMode.inviteToEditButton.title': '邀請編輯',
+  'fabric.editor.embedTitle': '嵌入',
   'fabric.editor.emoji': '表情符號',
   'fabric.editor.emoji.description': '使用表情符號來傳達想法 🎉 和情緒 😄',
   'fabric.editor.emptyLink': '請輸入連結。',
@@ -48,6 +60,8 @@ export default {
   'fabric.editor.horizontalRule.description': '使用水平線來區隔內容',
   'fabric.editor.hyperlinkToolbarPlaceholder': '貼上或搜尋連結',
   'fabric.editor.image': '影像',
+  'fabric.editor.inlineDescription': '將連結顯示為內嵌文字',
+  'fabric.editor.inlineTitle': '內嵌',
   'fabric.editor.insertMenu': '插入',
   'fabric.editor.invalidLink': '請輸入有效的連結。',
   'fabric.editor.layoutFixedWidth': '返回中央',
@@ -87,6 +101,9 @@ export default {
   'fabric.editor.unsupportedBlockContent': '此編輯器不支援顯示此內容',
   'fabric.editor.unsupportedContentTooltip': '內容不適用於此編輯器，這會在您編輯和儲存時進行保留',
   'fabric.editor.unsupportedInlineContent': '不支援的內容',
+  'fabric.editor.url': '顯示 URL',
+  'fabric.editor.urlDescription': '將連結顯示為 URL',
+  'fabric.editor.urlTitle': 'URL',
   'fabric.editor.viewMore': '檢視更多',
   'fabric.editor.visit': '在新視窗中開啟連結',
   'fabric.editor.wrapLeft': '靠左圍繞',

package/dist/esm/monitoring/error.js

@@ -6,7 +6,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var SENTRY_DSN = 'https://0b10c8e02fb44d8796c047b102c9bee8@o55978.ingest.sentry.io/4505129224110080';
 var packageName = 'editor-common'; // Sentry doesn't accept '/' in its releases https://docs.sentry.io/platforms/javascript/configuration/releases/
-var packageVersion = "74.20.0";
+var packageVersion = "74.21.1";
 var sanitiseSentryEvents = function sanitiseSentryEvents(data, _hint) {
   // Remove URL as it has UGC
   // TODO: Sanitise the URL instead of just removing it

package/dist/esm/quick-insert/assets/datasource-jira-issue.js

@@ -0,0 +1,100 @@
+// TODO: https://product-fabric.atlassian.net/browse/DSP-4138
+/* eslint-disable @atlaskit/design-system/ensure-design-token-usage */
+import React from 'react';
+export default function IconDatasourceJiraIssue() {
+  return /*#__PURE__*/React.createElement("svg", {
+    width: "40",
+    height: "40",
+    viewBox: "0 0 40 40",
+    fill: "none",
+    xmlns: "http://www.w3.org/2000/svg"
+  }, /*#__PURE__*/React.createElement("g", {
+    clipPath: "url(#clip0_503_53432)"
+  }, /*#__PURE__*/React.createElement("rect", {
+    width: "40",
+    height: "40",
+    rx: "3",
+    fill: "white"
+  }), /*#__PURE__*/React.createElement("path", {
+    fillRule: "evenodd",
+    clipRule: "evenodd",
+    d: "M18 12H44V22H18V12Z",
+    fill: "white",
+    stroke: "#C1C7D0"
+  }), /*#__PURE__*/React.createElement("path", {
+    fillRule: "evenodd",
+    clipRule: "evenodd",
+    d: "M18 8H43C43.5523 8 44 8.44772 44 9V12H18V8Z",
+    fill: "#DFE1E6",
+    stroke: "#C1C7D0"
+  }), /*#__PURE__*/React.createElement("path", {
+    fillRule: "evenodd",
+    clipRule: "evenodd",
+    d: "M18 22H44V31C44 31.5523 43.5523 32 43 32H18V22Z",
+    fill: "white",
+    stroke: "#C1C7D0"
+  }), /*#__PURE__*/React.createElement("path", {
+    fillRule: "evenodd",
+    clipRule: "evenodd",
+    d: "M7 12H19V22H7V12Z",
+    fill: "white",
+    stroke: "#C1C7D0"
+  }), /*#__PURE__*/React.createElement("path", {
+    fillRule: "evenodd",
+    clipRule: "evenodd",
+    d: "M7 9C7 8.44772 7.44772 8 8 8H19V12H7V9Z",
+    fill: "#DFE1E6",
+    stroke: "#C1C7D0"
+  }), /*#__PURE__*/React.createElement("path", {
+    fillRule: "evenodd",
+    clipRule: "evenodd",
+    d: "M7 22H19V32H8C7.44772 32 7 31.5523 7 31V22Z",
+    fill: "white",
+    stroke: "#C1C7D0"
+  }), /*#__PURE__*/React.createElement("rect", {
+    x: "10",
+    y: "14",
+    width: "6",
+    height: "6",
+    rx: "1",
+    fill: "#FF5230"
+  }), /*#__PURE__*/React.createElement("path", {
+    fillRule: "evenodd",
+    clipRule: "evenodd",
+    d: "M13 18C13.5523 18 14 17.5523 14 17C14 16.4477 13.5523 16 13 16C12.4477 16 12 16.4477 12 17C12 17.5523 12.4477 18 13 18Z",
+    fill: "white"
+  }), /*#__PURE__*/React.createElement("rect", {
+    x: "10",
+    y: "24",
+    width: "6",
+    height: "6",
+    rx: "1",
+    fill: "#36B37E"
+  }), /*#__PURE__*/React.createElement("path", {
+    fillRule: "evenodd",
+    clipRule: "evenodd",
+    d: "M12.2 25.7002C12.0895 25.7002 12 25.7897 12 25.9002V28.2174C12 28.3955 12.2154 28.4848 12.3414 28.3588L13 27.7002L13.6586 28.3588C13.7846 28.4848 14 28.3955 14 28.2174V25.9002C14 25.7897 13.9105 25.7002 13.8 25.7002H12.2Z",
+    fill: "white"
+  }), /*#__PURE__*/React.createElement("rect", {
+    x: "22",
+    y: "16",
+    width: "19",
+    height: "2",
+    rx: "1",
+    fill: "#C1C7D0"
+  }), /*#__PURE__*/React.createElement("rect", {
+    x: "22",
+    y: "26",
+    width: "19",
+    height: "2",
+    rx: "1",
+    fill: "#C1C7D0"
+  })), /*#__PURE__*/React.createElement("defs", null, /*#__PURE__*/React.createElement("clipPath", {
+    id: "clip0_503_53432"
+  }, /*#__PURE__*/React.createElement("rect", {
+    width: "40",
+    height: "40",
+    rx: "3",
+    fill: "white"
+  }))));
+}

package/dist/esm/quick-insert/assets/index.js

@@ -245,4 +245,14 @@ export var IconExpand = Loadable({
   loading: function loading() {
     return null;
   }
+});
+export var IconDatasourceJiraIssue = Loadable({
+  loader: function loader() {
+    return import( /* webpackChunkName: "@atlaskit-internal_editor-icon-datasource-jira-issue" */'./datasource-jira-issue').then(function (module) {
+      return module.default;
+    });
+  },
+  loading: function loading() {
+    return null;
+  }
 });

package/dist/esm/quick-insert/index.js

@@ -1 +1 @@
-export { IconAction, IconCode, IconDate, IconDecision, IconDivider, IconEmoji, IconImages, IconLayout, IconLink, IconListNumber, IconList, IconMention, IconPanelError, IconPanelNote, IconPanelSuccess, IconPanelWarning, IconPanel, IconQuote, IconStatus, IconHeading, IconFeedback, IconExpand, IconCustomPanel, IconFallback } from './assets';
+export { IconAction, IconCode, IconDate, IconDecision, IconDivider, IconEmoji, IconImages, IconLayout, IconLink, IconListNumber, IconList, IconMention, IconPanelError, IconPanelNote, IconPanelSuccess, IconPanelWarning, IconPanel, IconQuote, IconStatus, IconHeading, IconFeedback, IconExpand, IconCustomPanel, IconFallback, IconDatasourceJiraIssue } from './assets';

package/dist/esm/types/datasource.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/ui/DropList/index.js

@@ -18,7 +18,7 @@ import { themed } from '@atlaskit/theme/components';
 import { borderRadius } from '@atlaskit/theme/constants';
 import Layer from '../Layer';
 var packageName = "@atlaskit/editor-common";
-var packageVersion = "74.20.0";
+var packageVersion = "74.21.1";
 var halfFocusRing = 1;
 var dropOffset = '0, 8';
 var DropList = /*#__PURE__*/function (_Component) {

package/dist/esm/utils/datasource.js

@@ -1,16 +1,16 @@
 import { JIRA_LIST_OF_LINKS_DATASOURCE_ID } from '@atlaskit/link-datasource';
 import { getBooleanFF } from '@atlaskit/platform-feature-flags';
-var getDatasourceType = function getDatasourceType(datasource) {
-  switch (datasource.id) {
+var getDatasourceType = function getDatasourceType(datasourceId) {
+  switch (datasourceId) {
     case JIRA_LIST_OF_LINKS_DATASOURCE_ID:
       return 'jira';
     default:
       return undefined;
   }
 };
-export var canRenderDatasource = function canRenderDatasource(datasource) {
+export var canRenderDatasource = function canRenderDatasource(datasourceId) {
   var defaultValue = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
-  var datasourceType = getDatasourceType(datasource);
+  var datasourceType = getDatasourceType(datasourceId);
   switch (datasourceType) {
     case 'jira':
       if (getBooleanFF('platform.linking-platform.datasource-jira_issues')) {

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-common",
-	"version": "74.20.0",
+	"version": "74.21.1",
 	"sideEffects": false
 }

package/dist/types/analytics/types/events.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import type { EditorState, PluginKey } from 'prosemirror-state';
 import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import type { NewCollabSyncUpErrorAttributes } from '@atlaskit/collab-provider/types';
+import type { NewCollabSyncUpErrorAttributes } from '../../collab';
 import type { UnsupportedContentPayload, UnsupportedContentTooltipPayload, UserBrowserExtensionResults } from '../../utils';
 import type { AvatarEventPayload } from './avatar';
 import type { ConfigPanelEventPayload } from './config-panel-events';

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

@@ -0,0 +1,351 @@
+import type { EditorState, Transaction } from 'prosemirror-state';
+import type { Step } from 'prosemirror-transform';
+import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
+export type NewCollabSyncUpErrorAttributes = {
+    lengthOfUnconfirmedSteps?: number;
+    tries: number;
+    maxRetries: number;
+    clientId?: number | string;
+    version: number;
+};
+export type ResolvedEditorState<T = any> = {
+    content: JSONDocNode | T;
+    title: string | null;
+    stepVersion: number;
+};
+export declare enum PROVIDER_ERROR_CODE {
+    NO_PERMISSION_ERROR = "NO_PERMISSION_ERROR",
+    INVALID_USER_TOKEN = "INVALID_USER_TOKEN",
+    DOCUMENT_NOT_FOUND = "DOCUMENT_NOT_FOUND",
+    LOCKED = "LOCKED",
+    FAIL_TO_SAVE = "FAIL_TO_SAVE",
+    DOCUMENT_RESTORE_ERROR = "DOCUMENT_RESTORE_ERROR",
+    INITIALISATION_ERROR = "INITIALISATION_ERROR",
+    NETWORK_ISSUE = "NETWORK_ISSUE",
+    INVALID_PROVIDER_CONFIGURATION = "INVALID_PROVIDER_CONFIGURATION",
+    INTERNAL_SERVICE_ERROR = "INTERNAL_SERVICE_ERROR",
+    DOCUMENT_UPDATE_ERROR = "DOCUMENT_UPDATE_ERROR"
+}
+/**
+ * This occurs when the provided user token is considered invalid for the given document ARI.
+ * It happens during initialisation of the provider.
+ * It could mean the document has been deleted (hence not found).
+ * @message Message returned to editor, i.e User does not have permissions to access this document or document is not found
+ * @recoverable It is recoverable, as we will try to refresh the token.
+ */
+type InsufficientEditingPermission = {
+    code: PROVIDER_ERROR_CODE.NO_PERMISSION_ERROR;
+    message: string;
+    recoverable: boolean;
+    reason?: string;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
+/**
+ * Similar to InsufficientEditingPermission, but the user token is invalid because it has expired or been revoked.
+ * It may also be an invalid token format.
+ * This error is given to the provider by NCS.
+ * @message Message returned to editor, i.e. The user token was invalid
+ * @recoverable It is recoverable, as we will try to refresh the token.
+ */
+type InvalidUserToken = {
+    code: PROVIDER_ERROR_CODE.INVALID_USER_TOKEN;
+    message: string;
+    recoverable: boolean;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
+/**
+ * Document not found error, thrown when the provider is unable to find a document with the given ARI and user token.
+ * It occurs during fetchCatchup, a function that fetches the latest document state during catchup.
+ * We need to recieve a 404 from the document service to throw this error.
+ * @message Message returned to editor, i.e. The requested document is not found
+ * @recoverable It is recoverable, as the provider can try again later.
+ */
+type DocumentNotFound = {
+    code: PROVIDER_ERROR_CODE.DOCUMENT_NOT_FOUND;
+    message: string;
+    recoverable: boolean;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
+/**
+ * This error is thrown when the document is locked by another user.
+ * The error is passed to us by NCS.
+ * @message Message returned to editor, i.e. The document is currently not available, please try again later
+ * @recoverable It is recoverable, as the provider can try again later.
+ */
+type Locked = {
+    code: PROVIDER_ERROR_CODE.LOCKED;
+    message: string;
+    recoverable: boolean;
+    status?: number;
+};
+/**
+ * This error is thrown when the provider is unable to save the document.
+ * This can happen when the connection to dynamoDB is lost, or when we do not have sufficient permissions (DYNAMO ERROR).
+ * This error is given to us by NCS.
+ * @message Message returned to editor, i.e. Collab service is not able to save changes
+ * @recoverable It is not recoverable, as we don't want the user to continue editing a document that is not being saved.
+ */
+type FailToSave = {
+    code: PROVIDER_ERROR_CODE.FAIL_TO_SAVE;
+    message: string;
+    recoverable: boolean;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
+/**
+ * This error is thrown when the provider is unable to restore the document.
+ * It occurs during onRestore, a function that restores the document to a previous version and reapplies unconfirmed steps.
+ * onRestore is called when page recovery has emitted an 'init' event on a page client is currently connected to.
+ * It could mean we failed to update the page metadata, or we failed to reapply unconfirmed steps.
+ * @message Message returned to editor, i.e. Collab service unable to restore document
+ * @recoverable It is not recoverable, as the provider has no further options after this.
+ * The user will need to refresh the page to try again.
+ */
+type DocumentNotRestore = {
+    code: PROVIDER_ERROR_CODE.DOCUMENT_RESTORE_ERROR;
+    message: string;
+    recoverable: boolean;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
+/**
+ * The initial document couldn't be loaded from the collab service.
+ * This error is given to us by NCS.
+ * It could indicate either a network issue, or an internal service error in NCS.
+ * @message Message returned to editor, i.e. The initial document couldn't be loaded from the collab service
+ * @recoverable It is not recoverable, as the provider cannot do anything to fix it.
+ * The user will need to refresh the page to try again.
+ */
+type InitialisationError = {
+    code: PROVIDER_ERROR_CODE.INITIALISATION_ERROR;
+    message: string;
+    recoverable: boolean;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
+/**
+ * Couldn't reconnect to the collab service (NCS) due to network issues.
+ * NCS could be down, or the user could be offline. It's also possible the url is incorrect, or the user is behind a proxy blocking the connection.
+ * Fired upon a reconnection attempt error (from Socket.IO Manager)
+ * @message Message returned to editor, i.e. Couldn't reconnect to the collab service due to network issues
+ * @recoverable It is recoverable, as the provider will try to reconnect.
+ */
+type NetworkIssue = {
+    code: PROVIDER_ERROR_CODE.NETWORK_ISSUE;
+    message: string;
+    recoverable: boolean;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
+/**
+ * This error is thrown when the provider has an invalid configuration.
+ * It could happen due to these errors from NCS:
+ *  NAMESPACE_INVALID
+    INVALID_ACTIVATION_ID
+    INVALID_DOCUMENT_ARI
+    INVALID_CLOUD_ID
+ * @message Message returned to editor, i.e. Invalid provider configuration
+ * @recoverable It is not recoverable, as the provider cannot do anything to fix it.
+ * The service using the provider will need to fix the configuration.
+ */
+type InvalidProviderConfiguration = {
+    code: PROVIDER_ERROR_CODE.INVALID_PROVIDER_CONFIGURATION;
+    message: string;
+    recoverable: boolean;
+    reason: string;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
+/**
+ * This error is thrown when the provider encounters an internal service error, not otherwise accounted for.
+ * @message Message returned to editor, i.e. Collab Provider experienced an unrecoverable error
+ * @recoverable It is not recoverable, as the provider cannot do anything to fix it.
+ */
+type InternalServiceError = {
+    code: PROVIDER_ERROR_CODE.INTERNAL_SERVICE_ERROR;
+    message: string;
+    recoverable: boolean;
+    reason: string;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
+type ProviderDocumentUpdateError = {
+    code: PROVIDER_ERROR_CODE.DOCUMENT_UPDATE_ERROR;
+    message: 'The provider failed to apply changes to the editor';
+    recoverable: boolean;
+    /**
+     * @deprecated switch to using either the error code or the recoverable flag
+     */
+    status?: number;
+};
+/**
+ * A union of all possible provider errors that can be emitted back to the editor.
+ */
+export type ProviderError = InsufficientEditingPermission | InvalidUserToken | DocumentNotFound | Locked | FailToSave | DocumentNotRestore | InitialisationError | NetworkIssue | InvalidProviderConfiguration | InternalServiceError | ProviderDocumentUpdateError;
+export interface Metadata {
+    [key: string]: string | number | boolean;
+}
+export type CollabMetadataPayload = Metadata;
+export interface CollabEventInitData {
+    doc?: any;
+    json?: any;
+    version?: number;
+    sid?: string;
+    reserveCursor?: boolean;
+}
+export interface CollabInitPayload extends CollabEventInitData {
+    doc: any;
+    version: number;
+    metadata?: Metadata;
+    reserveCursor?: boolean;
+}
+export interface CollabEventConnectionData {
+    sid: string;
+    initial: boolean;
+}
+export type CollabConnectedPayload = CollabEventConnectionData;
+export 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"
+}
+export interface CollabDisconnectedPayload {
+    reason: DisconnectReason;
+    sid: string;
+}
+export interface CollabEventRemoteData {
+    json?: any;
+    newState?: EditorState;
+    userIds?: (number | string)[];
+}
+type MarkJson = {
+    type: string;
+    attrs: {
+        [key: string]: any;
+    };
+};
+type NodeJson = {
+    type: string;
+    attrs: {
+        [key: string]: any;
+    };
+    content: NodeJson[];
+    marks: MarkJson[];
+    text?: string;
+};
+type SliceJson = {
+    content: NodeJson[];
+    openStart: number;
+    openEnd: number;
+};
+export type StepJson = {
+    stepType?: string;
+    from?: number;
+    to?: number;
+    slice?: SliceJson;
+    clientId: number | string;
+    userId: string;
+    createdAt?: number;
+    structure?: boolean;
+};
+export interface CollabDataPayload extends CollabEventRemoteData {
+    version: number;
+    json: StepJson[];
+    userIds: (number | string)[];
+}
+export interface CollabSendableSelection {
+    type: 'textSelection' | 'nodeSelection';
+    anchor?: number | string;
+    head?: number | string;
+}
+export interface CollabEventTelepointerData {
+    type: 'telepointer';
+    selection: CollabSendableSelection;
+    sessionId: string;
+}
+export type CollabTelepointerPayload = CollabEventTelepointerData;
+export interface CollabParticipant {
+    lastActive: number;
+    sessionId: string;
+    avatar: string;
+    name: string;
+    cursorPos?: number;
+}
+export type ProviderParticipant = CollabParticipant & {
+    userId: string;
+    clientId: number | string;
+    email: string;
+};
+export interface CollabEventPresenceData {
+    joined?: ProviderParticipant[];
+    left?: {
+        sessionId: string;
+    }[];
+}
+export type CollabPresencePayload = CollabEventPresenceData;
+export type CollabLocalStepsPayload = {
+    steps: readonly Step[];
+};
+export interface CollabEventConnectingData {
+    initial: boolean;
+}
+export type CollabConnectingPayload = CollabEventConnectingData;
+export type CollabCommitStatusEventPayload = {
+    status: 'attempt' | 'success' | 'failure';
+    version: number;
+};
+export interface CollabEvents {
+    'metadata:changed': Metadata;
+    init: CollabInitPayload;
+    connected: CollabConnectedPayload;
+    disconnected: CollabDisconnectedPayload;
+    data: CollabDataPayload;
+    telepointer: CollabTelepointerPayload;
+    presence: CollabPresencePayload;
+    'local-steps': CollabLocalStepsPayload;
+    error: ProviderError;
+    entity: any;
+    connecting: CollabConnectingPayload;
+    'commit-status': CollabCommitStatusEventPayload;
+}
+export type SyncUpErrorFunction = (attributes: NewCollabSyncUpErrorAttributes) => void;
+export interface CollabEditProvider<Events extends CollabEvents = CollabEvents> {
+    initialize(getState: () => any, createStep: (json: object) => Step): this;
+    setup(props: {
+        getState?: () => EditorState;
+        onSyncUpError?: SyncUpErrorFunction;
+    }): this;
+    send(tr: Transaction, oldState: EditorState, newState: EditorState): void;
+    on(evt: keyof Events, handler: (...args: any) => void): this;
+    off(evt: keyof Events, handler: (...args: any) => void): this;
+    unsubscribeAll(evt: keyof Events): this;
+    sendMessage<K extends keyof Events>(data: {
+        type: K;
+    } & Events[K]): void;
+    getFinalAcknowledgedState(): Promise<ResolvedEditorState>;
+}
+export {};