@atlaskit/editor-synced-block-provider 0.8.0 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-synced-block-provider
 
+## 1.0.0
+
+### Major Changes
+
+- [`10882b2fab738`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/10882b2fab738) -
+  [ux] Introduced bodiedSyncBlock nodeview
+
+## 0.9.0
+
+### Minor Changes
+
+- [`d69b1dec4af70`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d69b1dec4af70) -
+  Generate link to source block with localid parameter
+
 ## 0.8.0
 
 ### Minor Changes

package/dist/cjs/common/syncBlockProvider.js

@@ -65,7 +65,7 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
     value: function writeNodesData(nodes, data) {
       var _this3 = this;
       var resourceIds = [];
-      nodes.forEach(function (node, index) {
+      nodes.forEach(function (_node, index) {
         if (!data[index].content) {
           resourceIds.push(Promise.reject('No Synced Blockcontent to write'));
           return;
@@ -85,14 +85,20 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
     value: function retrieveSyncBlockSourceUrl(node) {
       var resourceId = node.attrs.resourceId;
       var pageARI;
+      var sourceLocalId;
       if (resourceId && typeof resourceId === 'string') {
         try {
           pageARI = (0, _ari.getPageARIFromResourceId)(resourceId);
         } catch (error) {
           return Promise.reject(error);
         }
+        try {
+          sourceLocalId = (0, _ari.getLocalIdFromAri)(resourceId);
+        } catch (error) {
+          // EDITOR-1921: log analytic here, safe to continue
+        }
       }
-      return pageARI ? fetchURLfromARI(pageARI) : Promise.resolve(undefined);
+      return pageARI ? fetchURLfromARI(pageARI, sourceLocalId) : Promise.resolve(undefined);
     }
   }]);
 }(_types.SyncBlockDataProvider);
@@ -142,7 +148,7 @@ var useHandleContentChanges = exports.useHandleContentChanges = function useHand
     }
     var syncBlockNode = (0, _utils.convertSyncBlockPMNodeToSyncBlockData)(node, false);
     var data = {
-      content: updatedDoc.toJSON(),
+      content: updatedDoc,
       resourceId: node.attrs.resourceId,
       localId: node.attrs.localId
     };
@@ -150,7 +156,7 @@ var useHandleContentChanges = exports.useHandleContentChanges = function useHand
   }, [isSource, node, provider, updatedDoc]);
 };
 var fetchURLfromARI = /*#__PURE__*/function () {
-  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(ari) {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(ari, sourceLocalId) {
     var response, _payload$data, payload, url;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
@@ -181,7 +187,7 @@ var fetchURLfromARI = /*#__PURE__*/function () {
             _context.next = 10;
             break;
           }
-          return _context.abrupt("return", url);
+          return _context.abrupt("return", sourceLocalId ? url + "?block=".concat(sourceLocalId) : url);
         case 10:
           _context.next = 13;
           break;
@@ -196,7 +202,7 @@ var fetchURLfromARI = /*#__PURE__*/function () {
       }
     }, _callee);
   }));
-  return function fetchURLfromARI(_x) {
+  return function fetchURLfromARI(_x, _x2) {
     return _ref.apply(this, arguments);
   };
 }();

package/dist/cjs/common/syncBlockStoreManager.js

@@ -87,21 +87,11 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
     value: function setEditorView(editorView) {
       this.editorView = editorView;
     }
-  }, {
-    key: "setSyncBlockNestedEditorView",
-    value: function setSyncBlockNestedEditorView(editorView) {
-      this.syncBlockNestedEditorView = editorView;
-    }
-  }, {
-    key: "getSyncBlockNestedEditorView",
-    value: function getSyncBlockNestedEditorView() {
-      return this.syncBlockNestedEditorView;
-    }
   }, {
     key: "isSourceBlock",
     value: function isSourceBlock(node) {
       var _this$dataProvider;
-      if (node.type.name !== 'syncBlock') {
+      if (node.type.name !== 'bodiedSyncBlock') {
         return false;
       }
       var _node$attrs2 = node.attrs,

package/dist/cjs/utils/ari.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.resourceIdFromSourceAndLocalId = exports.getPageIdAndTypeFromAri = exports.getPageARIFromResourceId = exports.getLocalIdFromAri = exports.getContentPropertyIdFromAri = exports.getContentPropertyAri = exports.getConfluencePageAri = void 0;
+exports.resourceIdFromSourceAndLocalId = exports.getPageIdAndTypeFromAri = exports.getPageARIFromResourceId = exports.getLocalIdFromAri = exports.getContentPropertyAri = exports.getConfluencePageAri = void 0;
 /* eslint-disable require-unicode-regexp  */
 
 var getConfluencePageAri = exports.getConfluencePageAri = function getConfluencePageAri(pageId, cloudId) {
@@ -37,21 +37,6 @@ var getPageARIFromResourceId = exports.getPageARIFromResourceId = function getPa
 var getContentPropertyAri = exports.getContentPropertyAri = function getContentPropertyAri(contentPropertyId, cloudId) {
   return "ari:cloud:confluence:".concat(cloudId, ":content/").concat(contentPropertyId);
 };
-
-/**
- * DEPRECATED - Will be removed in the future
- * @private
- * @deprecated
- * @param ari
- * @returns
- */
-var getContentPropertyIdFromAri = exports.getContentPropertyIdFromAri = function getContentPropertyIdFromAri(ari) {
-  var match = ari.match(/ari:cloud:confluence:[^:]+:content\/([^/]+)/);
-  if (match) {
-    return match[1];
-  }
-  throw new Error("Invalid content property ARI: ".concat(ari));
-};
 var resourceIdFromSourceAndLocalId = exports.resourceIdFromSourceAndLocalId = function resourceIdFromSourceAndLocalId(sourceId, localId) {
   return sourceId + '/' + localId;
 };

package/dist/es2019/common/syncBlockProvider.js

@@ -1,6 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { useEffect, useState, useMemo } from 'react';
-import { getPageARIFromResourceId } from '../utils/ari';
+import { getLocalIdFromAri, getPageARIFromResourceId } from '../utils/ari';
 import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 import { SyncBlockDataProvider } from './types';
 export class SyncBlockProvider extends SyncBlockDataProvider {
@@ -32,7 +32,7 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
    */
   writeNodesData(nodes, data) {
     const resourceIds = [];
-    nodes.forEach((node, index) => {
+    nodes.forEach((_node, index) => {
       if (!data[index].content) {
         resourceIds.push(Promise.reject('No Synced Blockcontent to write'));
         return;
@@ -50,14 +50,20 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
       resourceId
     } = node.attrs;
     let pageARI;
+    let sourceLocalId;
     if (resourceId && typeof resourceId === 'string') {
       try {
         pageARI = getPageARIFromResourceId(resourceId);
       } catch (error) {
         return Promise.reject(error);
       }
+      try {
+        sourceLocalId = getLocalIdFromAri(resourceId);
+      } catch (error) {
+        // EDITOR-1921: log analytic here, safe to continue
+      }
     }
-    return pageARI ? fetchURLfromARI(pageARI) : Promise.resolve(undefined);
+    return pageARI ? fetchURLfromARI(pageARI, sourceLocalId) : Promise.resolve(undefined);
   }
 }
 export const useFetchDocNode = (editorView, node, defaultDocNode, provider) => {
@@ -104,14 +110,14 @@ export const useHandleContentChanges = (updatedDoc, isSource, node, provider) =>
     }
     const syncBlockNode = convertSyncBlockPMNodeToSyncBlockData(node, false);
     const data = {
-      content: updatedDoc.toJSON(),
+      content: updatedDoc,
       resourceId: node.attrs.resourceId,
       localId: node.attrs.localId
     };
     provider === null || provider === void 0 ? void 0 : provider.writeNodesData([syncBlockNode], [data]);
   }, [isSource, node, provider, updatedDoc]);
 };
-const fetchURLfromARI = async ari => {
+const fetchURLfromARI = async (ari, sourceLocalId) => {
   const response = await fetch('/gateway/api/object-resolver/resolve/ari', {
     method: 'POST',
     headers: {
@@ -127,7 +133,7 @@ const fetchURLfromARI = async ari => {
     const payload = await response.json();
     const url = payload === null || payload === void 0 ? void 0 : (_payload$data = payload.data) === null || _payload$data === void 0 ? void 0 : _payload$data.url;
     if (typeof url === 'string') {
-      return url;
+      return sourceLocalId ? url + `?block=${sourceLocalId}` : url;
     }
   } else {
     //eslint-disable-next-line no-console

package/dist/es2019/common/syncBlockStoreManager.js

@@ -71,15 +71,9 @@ export class SyncBlockStoreManager {
   setEditorView(editorView) {
     this.editorView = editorView;
   }
-  setSyncBlockNestedEditorView(editorView) {
-    this.syncBlockNestedEditorView = editorView;
-  }
-  getSyncBlockNestedEditorView() {
-    return this.syncBlockNestedEditorView;
-  }
   isSourceBlock(node) {
     var _this$dataProvider;
-    if (node.type.name !== 'syncBlock') {
+    if (node.type.name !== 'bodiedSyncBlock') {
       return false;
     }
     const {

package/dist/es2019/utils/ari.js

@@ -26,21 +26,6 @@ export const getPageARIFromResourceId = resourceId => {
   throw new Error(`Invalid resourceId: ${resourceId}`);
 };
 export const getContentPropertyAri = (contentPropertyId, cloudId) => `ari:cloud:confluence:${cloudId}:content/${contentPropertyId}`;
-
-/**
- * DEPRECATED - Will be removed in the future
- * @private
- * @deprecated
- * @param ari
- * @returns
- */
-export const getContentPropertyIdFromAri = ari => {
-  const match = ari.match(/ari:cloud:confluence:[^:]+:content\/([^/]+)/);
-  if (match) {
-    return match[1];
-  }
-  throw new Error(`Invalid content property ARI: ${ari}`);
-};
 export const resourceIdFromSourceAndLocalId = (sourceId, localId) => {
   return sourceId + '/' + localId;
 };

package/dist/esm/common/syncBlockProvider.js

@@ -12,7 +12,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import { useEffect, useState, useMemo } from 'react';
-import { getPageARIFromResourceId } from '../utils/ari';
+import { getLocalIdFromAri, getPageARIFromResourceId } from '../utils/ari';
 import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 import { SyncBlockDataProvider } from './types';
 export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
@@ -58,7 +58,7 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
     value: function writeNodesData(nodes, data) {
       var _this3 = this;
       var resourceIds = [];
-      nodes.forEach(function (node, index) {
+      nodes.forEach(function (_node, index) {
         if (!data[index].content) {
           resourceIds.push(Promise.reject('No Synced Blockcontent to write'));
           return;
@@ -78,14 +78,20 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
     value: function retrieveSyncBlockSourceUrl(node) {
       var resourceId = node.attrs.resourceId;
       var pageARI;
+      var sourceLocalId;
       if (resourceId && typeof resourceId === 'string') {
         try {
           pageARI = getPageARIFromResourceId(resourceId);
         } catch (error) {
           return Promise.reject(error);
         }
+        try {
+          sourceLocalId = getLocalIdFromAri(resourceId);
+        } catch (error) {
+          // EDITOR-1921: log analytic here, safe to continue
+        }
       }
-      return pageARI ? fetchURLfromARI(pageARI) : Promise.resolve(undefined);
+      return pageARI ? fetchURLfromARI(pageARI, sourceLocalId) : Promise.resolve(undefined);
     }
   }]);
 }(SyncBlockDataProvider);
@@ -135,7 +141,7 @@ export var useHandleContentChanges = function useHandleContentChanges(updatedDoc
     }
     var syncBlockNode = convertSyncBlockPMNodeToSyncBlockData(node, false);
     var data = {
-      content: updatedDoc.toJSON(),
+      content: updatedDoc,
       resourceId: node.attrs.resourceId,
       localId: node.attrs.localId
     };
@@ -143,7 +149,7 @@ export var useHandleContentChanges = function useHandleContentChanges(updatedDoc
   }, [isSource, node, provider, updatedDoc]);
 };
 var fetchURLfromARI = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(ari) {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(ari, sourceLocalId) {
     var response, _payload$data, payload, url;
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
@@ -174,7 +180,7 @@ var fetchURLfromARI = /*#__PURE__*/function () {
             _context.next = 10;
             break;
           }
-          return _context.abrupt("return", url);
+          return _context.abrupt("return", sourceLocalId ? url + "?block=".concat(sourceLocalId) : url);
         case 10:
           _context.next = 13;
           break;
@@ -189,7 +195,7 @@ var fetchURLfromARI = /*#__PURE__*/function () {
       }
     }, _callee);
   }));
-  return function fetchURLfromARI(_x) {
+  return function fetchURLfromARI(_x, _x2) {
     return _ref.apply(this, arguments);
   };
 }();

package/dist/esm/common/syncBlockStoreManager.js

@@ -82,21 +82,11 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
     value: function setEditorView(editorView) {
       this.editorView = editorView;
     }
-  }, {
-    key: "setSyncBlockNestedEditorView",
-    value: function setSyncBlockNestedEditorView(editorView) {
-      this.syncBlockNestedEditorView = editorView;
-    }
-  }, {
-    key: "getSyncBlockNestedEditorView",
-    value: function getSyncBlockNestedEditorView() {
-      return this.syncBlockNestedEditorView;
-    }
   }, {
     key: "isSourceBlock",
     value: function isSourceBlock(node) {
       var _this$dataProvider;
-      if (node.type.name !== 'syncBlock') {
+      if (node.type.name !== 'bodiedSyncBlock') {
         return false;
       }
       var _node$attrs2 = node.attrs,

package/dist/esm/utils/ari.js

@@ -31,21 +31,6 @@ export var getPageARIFromResourceId = function getPageARIFromResourceId(resource
 export var getContentPropertyAri = function getContentPropertyAri(contentPropertyId, cloudId) {
   return "ari:cloud:confluence:".concat(cloudId, ":content/").concat(contentPropertyId);
 };
-
-/**
- * DEPRECATED - Will be removed in the future
- * @private
- * @deprecated
- * @param ari
- * @returns
- */
-export var getContentPropertyIdFromAri = function getContentPropertyIdFromAri(ari) {
-  var match = ari.match(/ari:cloud:confluence:[^:]+:content\/([^/]+)/);
-  if (match) {
-    return match[1];
-  }
-  throw new Error("Invalid content property ARI: ".concat(ari));
-};
 export var resourceIdFromSourceAndLocalId = function resourceIdFromSourceAndLocalId(sourceId, localId) {
   return sourceId + '/' + localId;
 };

package/dist/types/common/syncBlockProvider.d.ts

@@ -1,4 +1,5 @@
 import type { DocNode } from '@atlaskit/adf-schema';
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
@@ -25,4 +26,4 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
 }
 export declare const useFetchDocNode: (editorView: EditorView, node: PMNode, defaultDocNode: DocNode, provider?: SyncBlockDataProvider) => DocNode;
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;
-export declare const useHandleContentChanges: (updatedDoc: PMNode, isSource: boolean, node: PMNode, provider?: SyncBlockDataProvider) => void;
+export declare const useHandleContentChanges: (updatedDoc: ADFEntity | undefined, isSource: boolean, node: PMNode, provider?: SyncBlockDataProvider) => void;

package/dist/types/common/syncBlockStoreManager.d.ts

@@ -21,7 +21,6 @@ export declare class SyncBlockStoreManager {
     private editorView?;
     private dataProvider?;
     private confirmationTransaction?;
-    private syncBlockNestedEditorView?;
     constructor(dataProvider?: SyncBlockDataProvider);
     /**
      * Add/update a sync block node to the store.
@@ -36,8 +35,6 @@ export declare class SyncBlockStoreManager {
      */
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
     setEditorView(editorView: EditorView | undefined): void;
-    setSyncBlockNestedEditorView(editorView: EditorView | undefined): void;
-    getSyncBlockNestedEditorView(): EditorView | undefined;
     isSourceBlock(node: PMNode): boolean;
     registerConfirmationCallback(callback: ConfirmationCallback): () => void;
     requireConfirmationBeforeDelete(): boolean;

package/dist/types/utils/ari.d.ts

@@ -7,12 +7,4 @@ export declare const getPageIdAndTypeFromAri: (ari: string) => {
 export declare const getLocalIdFromAri: (ari: string) => string;
 export declare const getPageARIFromResourceId: (resourceId: string) => string;
 export declare const getContentPropertyAri: (contentPropertyId: string, cloudId: string) => string;
-/**
- * DEPRECATED - Will be removed in the future
- * @private
- * @deprecated
- * @param ari
- * @returns
- */
-export declare const getContentPropertyIdFromAri: (ari: string) => string;
 export declare const resourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;

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

@@ -1,4 +1,5 @@
 import type { DocNode } from '@atlaskit/adf-schema';
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
@@ -25,4 +26,4 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
 }
 export declare const useFetchDocNode: (editorView: EditorView, node: PMNode, defaultDocNode: DocNode, provider?: SyncBlockDataProvider) => DocNode;
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;
-export declare const useHandleContentChanges: (updatedDoc: PMNode, isSource: boolean, node: PMNode, provider?: SyncBlockDataProvider) => void;
+export declare const useHandleContentChanges: (updatedDoc: ADFEntity | undefined, isSource: boolean, node: PMNode, provider?: SyncBlockDataProvider) => void;

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

@@ -21,7 +21,6 @@ export declare class SyncBlockStoreManager {
     private editorView?;
     private dataProvider?;
     private confirmationTransaction?;
-    private syncBlockNestedEditorView?;
     constructor(dataProvider?: SyncBlockDataProvider);
     /**
      * Add/update a sync block node to the store.
@@ -36,8 +35,6 @@ export declare class SyncBlockStoreManager {
      */
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
     setEditorView(editorView: EditorView | undefined): void;
-    setSyncBlockNestedEditorView(editorView: EditorView | undefined): void;
-    getSyncBlockNestedEditorView(): EditorView | undefined;
     isSourceBlock(node: PMNode): boolean;
     registerConfirmationCallback(callback: ConfirmationCallback): () => void;
     requireConfirmationBeforeDelete(): boolean;

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

@@ -7,12 +7,4 @@ export declare const getPageIdAndTypeFromAri: (ari: string) => {
 export declare const getLocalIdFromAri: (ari: string) => string;
 export declare const getPageARIFromResourceId: (resourceId: string) => string;
 export declare const getContentPropertyAri: (contentPropertyId: string, cloudId: string) => string;
-/**
- * DEPRECATED - Will be removed in the future
- * @private
- * @deprecated
- * @param ari
- * @returns
- */
-export declare const getContentPropertyIdFromAri: (ari: string) => string;
 export declare const resourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;

package/package.json

@@ -82,7 +82,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "0.8.0",
+	"version": "1.0.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",