@atlaskit/editor-synced-block-renderer 2.2.4 → 2.3.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-synced-block-renderer
 
+## 2.3.0
+
+### Minor Changes
+
+- [`424619eee38cb`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/424619eee38cb) -
+  EDITOR-2451 add tests and refactor
+
+### Patch Changes
+
+- Updated dependencies
+
+## 2.2.5
+
+### Patch Changes
+
+- [`f282b1ca41f1c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f282b1ca41f1c) -
+  EDITOR-1648 refactor of sync block error types
+- Updated dependencies
+
 ## 2.2.4
 
 ### Patch Changes

package/dist/cjs/ui/SyncedBlockErrorComponent.js

@@ -8,13 +8,13 @@ exports.SyncedBlockErrorComponent = void 0;
 var _react = _interopRequireDefault(require("react"));
 var _editorSyncedBlockProvider = require("@atlaskit/editor-synced-block-provider");
 var SyncedBlockErrorComponent = exports.SyncedBlockErrorComponent = function SyncedBlockErrorComponent(_ref) {
-  var status = _ref.status;
-  switch (status) {
-    case _editorSyncedBlockProvider.SyncBlockStatus.Unauthorized:
+  var error = _ref.error;
+  switch (error) {
+    case _editorSyncedBlockProvider.SyncBlockError.Forbidden:
       return /*#__PURE__*/_react.default.createElement("div", null, "You don't have permission to view this sync block");
-    case _editorSyncedBlockProvider.SyncBlockStatus.NotFound:
+    case _editorSyncedBlockProvider.SyncBlockError.NotFound:
       return /*#__PURE__*/_react.default.createElement("div", null, "Sync Block Not Found");
-    case _editorSyncedBlockProvider.SyncBlockStatus.Errored:
+    case _editorSyncedBlockProvider.SyncBlockError.Errored:
     default:
       return /*#__PURE__*/_react.default.createElement("div", null, "Something went wrong");
   }

package/dist/cjs/ui/SyncedBlockNodeComponentRenderer.js

@@ -36,19 +36,14 @@ var SyncedBlockNodeComponentRenderer = exports.SyncedBlockNodeComponentRenderer
   var fetchResult = data.find(function (item) {
     return item.resourceId === props.resourceId;
   });
-  if (!fetchResult) {
+  if (fetchResult !== null && fetchResult !== void 0 && fetchResult.error || !(fetchResult !== null && fetchResult !== void 0 && fetchResult.data)) {
+    var _fetchResult$error;
     return /*#__PURE__*/_react.default.createElement(_SyncedBlockErrorComponent.SyncedBlockErrorComponent, {
-      status: _editorSyncedBlockProvider.SyncBlockStatus.Errored
+      error: (_fetchResult$error = fetchResult === null || fetchResult === void 0 ? void 0 : fetchResult.error) !== null && _fetchResult$error !== void 0 ? _fetchResult$error : _editorSyncedBlockProvider.SyncBlockError.Errored
     });
   }
-  if ('status' in fetchResult) {
-    return /*#__PURE__*/_react.default.createElement(_SyncedBlockErrorComponent.SyncedBlockErrorComponent, {
-      status: fetchResult.status
-    });
-  }
-  var syncBlockData = fetchResult;
   var syncBlockDoc = {
-    content: syncBlockData.content,
+    content: fetchResult.data.content,
     version: 1,
     type: 'doc'
   };

package/dist/cjs/ui/SyncedBlockRenderer.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.SyncedBlockRenderer = void 0;
 var _react = _interopRequireDefault(require("react"));
+var _editorSyncedBlockProvider = require("@atlaskit/editor-synced-block-provider");
 var _renderer = require("@atlaskit/renderer");
 var _actions = require("@atlaskit/renderer/actions");
 var _SyncedBlockErrorComponent = require("./SyncedBlockErrorComponent");
@@ -17,14 +18,14 @@ var SyncedBlockRenderer = exports.SyncedBlockRenderer = function SyncedBlockRend
   if (!fetchResult) {
     return /*#__PURE__*/_react.default.createElement(_SyncedBlockLoadingState.SyncedBlockLoadingState, null);
   }
-  if ('status' in fetchResult) {
+  if (fetchResult.error || !fetchResult.data) {
+    var _fetchResult$error;
     return /*#__PURE__*/_react.default.createElement(_SyncedBlockErrorComponent.SyncedBlockErrorComponent, {
-      status: fetchResult.status
+      error: (_fetchResult$error = fetchResult.error) !== null && _fetchResult$error !== void 0 ? _fetchResult$error : _editorSyncedBlockProvider.SyncBlockError.Errored
     });
   }
-  var syncBlockData = fetchResult;
   var syncBlockDoc = {
-    content: syncBlockData.content,
+    content: fetchResult.data.content,
     version: 1,
     type: 'doc'
   };

package/dist/es2019/ui/SyncedBlockErrorComponent.js

@@ -1,14 +1,14 @@
 import React from 'react';
-import { SyncBlockStatus } from '@atlaskit/editor-synced-block-provider';
+import { SyncBlockError } from '@atlaskit/editor-synced-block-provider';
 export const SyncedBlockErrorComponent = ({
-  status
+  error
 }) => {
-  switch (status) {
-    case SyncBlockStatus.Unauthorized:
+  switch (error) {
+    case SyncBlockError.Forbidden:
       return /*#__PURE__*/React.createElement("div", null, "You don't have permission to view this sync block");
-    case SyncBlockStatus.NotFound:
+    case SyncBlockError.NotFound:
       return /*#__PURE__*/React.createElement("div", null, "Sync Block Not Found");
-    case SyncBlockStatus.Errored:
+    case SyncBlockError.Errored:
     default:
       return /*#__PURE__*/React.createElement("div", null, "Something went wrong");
   }

package/dist/es2019/ui/SyncedBlockNodeComponentRenderer.js

@@ -1,5 +1,5 @@
 import React, { useEffect, useState } from 'react';
-import { SyncBlockStatus } from '@atlaskit/editor-synced-block-provider';
+import { SyncBlockError } from '@atlaskit/editor-synced-block-provider';
 import { ReactRenderer } from '@atlaskit/renderer';
 import { RendererActionsContext } from '@atlaskit/renderer/actions';
 import { SyncedBlockErrorComponent } from './SyncedBlockErrorComponent';
@@ -21,19 +21,14 @@ export const SyncedBlockNodeComponentRenderer = props => {
     return /*#__PURE__*/React.createElement(SyncedBlockLoadingState, null);
   }
   const fetchResult = data.find(item => item.resourceId === props.resourceId);
-  if (!fetchResult) {
+  if (fetchResult !== null && fetchResult !== void 0 && fetchResult.error || !(fetchResult !== null && fetchResult !== void 0 && fetchResult.data)) {
+    var _fetchResult$error;
     return /*#__PURE__*/React.createElement(SyncedBlockErrorComponent, {
-      status: SyncBlockStatus.Errored
+      error: (_fetchResult$error = fetchResult === null || fetchResult === void 0 ? void 0 : fetchResult.error) !== null && _fetchResult$error !== void 0 ? _fetchResult$error : SyncBlockError.Errored
     });
   }
-  if ('status' in fetchResult) {
-    return /*#__PURE__*/React.createElement(SyncedBlockErrorComponent, {
-      status: fetchResult.status
-    });
-  }
-  const syncBlockData = fetchResult;
   const syncBlockDoc = {
-    content: syncBlockData.content,
+    content: fetchResult.data.content,
     version: 1,
     type: 'doc'
   };

package/dist/es2019/ui/SyncedBlockRenderer.js

@@ -1,4 +1,5 @@
 import React from 'react';
+import { SyncBlockError } from '@atlaskit/editor-synced-block-provider';
 import { ReactRenderer } from '@atlaskit/renderer';
 import { RendererActionsContext } from '@atlaskit/renderer/actions';
 import { SyncedBlockErrorComponent } from './SyncedBlockErrorComponent';
@@ -11,14 +12,14 @@ export const SyncedBlockRenderer = ({
   if (!fetchResult) {
     return /*#__PURE__*/React.createElement(SyncedBlockLoadingState, null);
   }
-  if ('status' in fetchResult) {
+  if (fetchResult.error || !fetchResult.data) {
+    var _fetchResult$error;
     return /*#__PURE__*/React.createElement(SyncedBlockErrorComponent, {
-      status: fetchResult.status
+      error: (_fetchResult$error = fetchResult.error) !== null && _fetchResult$error !== void 0 ? _fetchResult$error : SyncBlockError.Errored
     });
   }
-  const syncBlockData = fetchResult;
   const syncBlockDoc = {
-    content: syncBlockData.content,
+    content: fetchResult.data.content,
     version: 1,
     type: 'doc'
   };

package/dist/esm/ui/SyncedBlockErrorComponent.js

@@ -1,13 +1,13 @@
 import React from 'react';
-import { SyncBlockStatus } from '@atlaskit/editor-synced-block-provider';
+import { SyncBlockError } from '@atlaskit/editor-synced-block-provider';
 export var SyncedBlockErrorComponent = function SyncedBlockErrorComponent(_ref) {
-  var status = _ref.status;
-  switch (status) {
-    case SyncBlockStatus.Unauthorized:
+  var error = _ref.error;
+  switch (error) {
+    case SyncBlockError.Forbidden:
       return /*#__PURE__*/React.createElement("div", null, "You don't have permission to view this sync block");
-    case SyncBlockStatus.NotFound:
+    case SyncBlockError.NotFound:
       return /*#__PURE__*/React.createElement("div", null, "Sync Block Not Found");
-    case SyncBlockStatus.Errored:
+    case SyncBlockError.Errored:
     default:
       return /*#__PURE__*/React.createElement("div", null, "Something went wrong");
   }

package/dist/esm/ui/SyncedBlockNodeComponentRenderer.js

@@ -1,6 +1,6 @@
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import React, { useEffect, useState } from 'react';
-import { SyncBlockStatus } from '@atlaskit/editor-synced-block-provider';
+import { SyncBlockError } from '@atlaskit/editor-synced-block-provider';
 import { ReactRenderer } from '@atlaskit/renderer';
 import { RendererActionsContext } from '@atlaskit/renderer/actions';
 import { SyncedBlockErrorComponent } from './SyncedBlockErrorComponent';
@@ -27,19 +27,14 @@ export var SyncedBlockNodeComponentRenderer = function SyncedBlockNodeComponentR
   var fetchResult = data.find(function (item) {
     return item.resourceId === props.resourceId;
   });
-  if (!fetchResult) {
+  if (fetchResult !== null && fetchResult !== void 0 && fetchResult.error || !(fetchResult !== null && fetchResult !== void 0 && fetchResult.data)) {
+    var _fetchResult$error;
     return /*#__PURE__*/React.createElement(SyncedBlockErrorComponent, {
-      status: SyncBlockStatus.Errored
+      error: (_fetchResult$error = fetchResult === null || fetchResult === void 0 ? void 0 : fetchResult.error) !== null && _fetchResult$error !== void 0 ? _fetchResult$error : SyncBlockError.Errored
     });
   }
-  if ('status' in fetchResult) {
-    return /*#__PURE__*/React.createElement(SyncedBlockErrorComponent, {
-      status: fetchResult.status
-    });
-  }
-  var syncBlockData = fetchResult;
   var syncBlockDoc = {
-    content: syncBlockData.content,
+    content: fetchResult.data.content,
     version: 1,
     type: 'doc'
   };

package/dist/esm/ui/SyncedBlockRenderer.js

@@ -1,4 +1,5 @@
 import React from 'react';
+import { SyncBlockError } from '@atlaskit/editor-synced-block-provider';
 import { ReactRenderer } from '@atlaskit/renderer';
 import { RendererActionsContext } from '@atlaskit/renderer/actions';
 import { SyncedBlockErrorComponent } from './SyncedBlockErrorComponent';
@@ -10,14 +11,14 @@ export var SyncedBlockRenderer = function SyncedBlockRenderer(_ref) {
   if (!fetchResult) {
     return /*#__PURE__*/React.createElement(SyncedBlockLoadingState, null);
   }
-  if ('status' in fetchResult) {
+  if (fetchResult.error || !fetchResult.data) {
+    var _fetchResult$error;
     return /*#__PURE__*/React.createElement(SyncedBlockErrorComponent, {
-      status: fetchResult.status
+      error: (_fetchResult$error = fetchResult.error) !== null && _fetchResult$error !== void 0 ? _fetchResult$error : SyncBlockError.Errored
     });
   }
-  var syncBlockData = fetchResult;
   var syncBlockDoc = {
-    content: syncBlockData.content,
+    content: fetchResult.data.content,
     version: 1,
     type: 'doc'
   };

package/dist/types/getSyncedBlockNodeComponent.d.ts

@@ -1,5 +1,5 @@
 import type { DocNode } from '@atlaskit/adf-schema';
-import { type SyncBlockNode, type FetchSyncBlockDataResult } from '@atlaskit/editor-synced-block-provider';
+import { type SyncBlockNode, type SyncBlockInstance } from '@atlaskit/editor-synced-block-provider';
 import type { NodeDataProvider } from '@atlaskit/node-data-provider';
 import { type SyncedBlockNodeProps } from './ui/SyncedBlockNodeComponentRenderer';
-export declare const getSyncedBlockNodeComponent: (dataProvider: NodeDataProvider<SyncBlockNode, FetchSyncBlockDataResult>, doc: DocNode) => (props: SyncedBlockNodeProps) => import("react").JSX.Element;
+export declare const getSyncedBlockNodeComponent: (dataProvider: NodeDataProvider<SyncBlockNode, SyncBlockInstance>, doc: DocNode) => (props: SyncedBlockNodeProps) => import("react").JSX.Element;

package/dist/types/ui/SyncedBlockErrorComponent.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { SyncBlockStatus } from '@atlaskit/editor-synced-block-provider';
-export declare const SyncedBlockErrorComponent: ({ status }: {
-    status: SyncBlockStatus;
+import { SyncBlockError } from '@atlaskit/editor-synced-block-provider';
+export declare const SyncedBlockErrorComponent: ({ error }: {
+    error: SyncBlockError;
 }) => React.JSX.Element;

package/dist/types/ui/SyncedBlockNodeComponentRenderer.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { type FetchSyncBlockDataResult } from '@atlaskit/editor-synced-block-provider';
+import { type SyncBlockInstance } from '@atlaskit/editor-synced-block-provider';
 import { type NodeProps } from '@atlaskit/renderer';
 export interface SyncedBlockProps {
     localId?: string;
@@ -7,5 +7,5 @@ export interface SyncedBlockProps {
 }
 export type SyncedBlockNodeProps = NodeProps<SyncedBlockProps>;
 export declare const SyncedBlockNodeComponentRenderer: (props: SyncedBlockNodeProps & {
-    dataPromise: Promise<FetchSyncBlockDataResult[]> | null;
+    dataPromise: Promise<SyncBlockInstance[]> | null;
 }) => React.JSX.Element;

package/dist/types/ui/SyncedBlockRenderer.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
-import { type FetchSyncBlockDataResult } from '@atlaskit/editor-synced-block-provider';
+import { type SyncBlockInstance } from '@atlaskit/editor-synced-block-provider';
 export type SyncedBlockRendererProps = {
     dataProviders?: ProviderFactory;
-    useFetchSyncBlockData: () => FetchSyncBlockDataResult | null;
+    useFetchSyncBlockData: () => SyncBlockInstance | null;
 };
 export declare const SyncedBlockRenderer: ({ useFetchSyncBlockData, dataProviders, }: SyncedBlockRendererProps) => React.JSX.Element;

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

@@ -1,5 +1,5 @@
 import type { DocNode } from '@atlaskit/adf-schema';
-import { type SyncBlockNode, type FetchSyncBlockDataResult } from '@atlaskit/editor-synced-block-provider';
+import { type SyncBlockNode, type SyncBlockInstance } from '@atlaskit/editor-synced-block-provider';
 import type { NodeDataProvider } from '@atlaskit/node-data-provider';
 import { type SyncedBlockNodeProps } from './ui/SyncedBlockNodeComponentRenderer';
-export declare const getSyncedBlockNodeComponent: (dataProvider: NodeDataProvider<SyncBlockNode, FetchSyncBlockDataResult>, doc: DocNode) => (props: SyncedBlockNodeProps) => import("react").JSX.Element;
+export declare const getSyncedBlockNodeComponent: (dataProvider: NodeDataProvider<SyncBlockNode, SyncBlockInstance>, doc: DocNode) => (props: SyncedBlockNodeProps) => import("react").JSX.Element;

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { SyncBlockStatus } from '@atlaskit/editor-synced-block-provider';
-export declare const SyncedBlockErrorComponent: ({ status }: {
-    status: SyncBlockStatus;
+import { SyncBlockError } from '@atlaskit/editor-synced-block-provider';
+export declare const SyncedBlockErrorComponent: ({ error }: {
+    error: SyncBlockError;
 }) => React.JSX.Element;

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { type FetchSyncBlockDataResult } from '@atlaskit/editor-synced-block-provider';
+import { type SyncBlockInstance } from '@atlaskit/editor-synced-block-provider';
 import { type NodeProps } from '@atlaskit/renderer';
 export interface SyncedBlockProps {
     localId?: string;
@@ -7,5 +7,5 @@ export interface SyncedBlockProps {
 }
 export type SyncedBlockNodeProps = NodeProps<SyncedBlockProps>;
 export declare const SyncedBlockNodeComponentRenderer: (props: SyncedBlockNodeProps & {
-    dataPromise: Promise<FetchSyncBlockDataResult[]> | null;
+    dataPromise: Promise<SyncBlockInstance[]> | null;
 }) => React.JSX.Element;

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

@@ -1,8 +1,8 @@
 import React from 'react';
 import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
-import { type FetchSyncBlockDataResult } from '@atlaskit/editor-synced-block-provider';
+import { type SyncBlockInstance } from '@atlaskit/editor-synced-block-provider';
 export type SyncedBlockRendererProps = {
     dataProviders?: ProviderFactory;
-    useFetchSyncBlockData: () => FetchSyncBlockDataResult | null;
+    useFetchSyncBlockData: () => SyncBlockInstance | null;
 };
 export declare const SyncedBlockRenderer: ({ useFetchSyncBlockData, dataProviders, }: SyncedBlockRendererProps) => React.JSX.Element;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-synced-block-renderer",
-	"version": "2.2.4",
+	"version": "2.3.0",
 	"description": "SyncedBlockRenderer for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -29,12 +29,12 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/editor-synced-block-provider": "^2.1.0",
+		"@atlaskit/editor-synced-block-provider": "^2.5.0",
 		"@atlaskit/renderer": "^124.9.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.18.0",
+		"@atlaskit/editor-common": "^110.21.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {

package/afm-post-office/tsconfig.json

@@ -1,35 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.post-office.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../post-office/tsDist/@atlaskit__editor-synced-block-renderer/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": [
-		{
-			"path": "../../editor-synced-block-provider/afm-post-office/tsconfig.json"
-		},
-		{
-			"path": "../../renderer/afm-post-office/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-post-office/tsconfig.json"
-		}
-	]
-}

package/afm-townsquare/tsconfig.json

@@ -1,35 +0,0 @@
-{
-	"extends": "../../../../tsconfig.entry-points.townsquare.json",
-	"compilerOptions": {
-		"target": "es5",
-		"outDir": "../../../../../townsquare/tsDist/@atlaskit__editor-synced-block-renderer/app",
-		"rootDir": "../",
-		"composite": true
-	},
-	"include": [
-		"../src/**/*.ts",
-		"../src/**/*.tsx"
-	],
-	"exclude": [
-		"../src/**/__tests__/*",
-		"../src/**/*.test.*",
-		"../src/**/test.*",
-		"../src/**/examples.*",
-		"../src/**/examples/*",
-		"../src/**/examples/**/*",
-		"../src/**/*.stories.*",
-		"../src/**/stories/*",
-		"../src/**/stories/**/*"
-	],
-	"references": [
-		{
-			"path": "../../editor-synced-block-provider/afm-townsquare/tsconfig.json"
-		},
-		{
-			"path": "../../renderer/afm-townsquare/tsconfig.json"
-		},
-		{
-			"path": "../../editor-common/afm-townsquare/tsconfig.json"
-		}
-	]
-}