@atlaskit/editor-synced-block-provider 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-synced-block-provider
 
+## 0.2.0
+
+### Minor Changes
+
+- [`6fabf6d555515`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6fabf6d555515) -
+  EDITOR-1566 add renderer sync-block node support
+
+## 0.1.3
+
+### Patch Changes
+
+- [`dd19fd49edc58`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/dd19fd49edc58) -
+  Added sync block quick insert
+
 ## 0.1.2
 
 ### Patch Changes

package/dist/cjs/common/schema.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getDefaultSyncBlockSchema = void 0;
+var _adfSchema = require("@atlaskit/adf-schema");
+/**
+ * We currently do not need any of the new features, like nested tables
+ * Otherwise we could import defaultSchemaConfig from '@atlaskit/adf-schema/schema-default';
+ * @returns
+ */
+var getDefaultSyncBlockSchema = exports.getDefaultSyncBlockSchema = function getDefaultSyncBlockSchema() {
+  return (0, _adfSchema.createSchema)({
+    nodes: ['doc', 'paragraph', 'text', 'bulletList', 'orderedList', 'listItem', 'heading', 'blockquote', 'codeBlock', 'panel', 'rule', 'expand', 'nestedExpand', 'table', 'tableCell', 'tableHeader', 'tableRow', 'date', 'status', 'layoutSection', 'layoutColumn', 'unsupportedBlock', 'unsupportedInline'],
+    marks: ['link', 'em', 'strong', 'strike', 'subsup', 'underline', 'code', 'textColor', 'backgroundColor', 'alignment', 'indentation', 'border', 'unsupportedMark', 'unsupportedNodeAttribute', 'typeAheadQuery']
+  });
+};

package/dist/cjs/common/syncBlockProvider.js

@@ -73,7 +73,7 @@ var useFetchDocNode = exports.useFetchDocNode = function useFetchDocNode(editorV
       return;
     }
     var interval = window.setInterval(function () {
-      var nodes = [(0, _utils.createSyncBlockNode)(node, false)];
+      var nodes = [(0, _utils.convertSyncBlockPMNodeToSyncBlockData)(node, false)];
       provider === null || provider === void 0 || provider.fetchNodesData(nodes).then(function (data) {
         var _data$;
         if (data && (_data$ = data[0]) !== null && _data$ !== void 0 && _data$.content) {

package/dist/cjs/common/syncBlockStoreManager.js

@@ -9,6 +9,7 @@ var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"))
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _uuid = _interopRequireDefault(require("uuid"));
 // Do this typedef to make it clear that
 // this is a local identifier for a resource for local use
 // A store manager responsible for the lifecycle and state management of sync blocks in an editor instance.
@@ -17,10 +18,9 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 // Handles caching, debouncing updates, and publish/subscribe for local changes.
 // Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
 var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/function () {
-  function SyncBlockStoreManager(dataProvider) {
+  function SyncBlockStoreManager(_dataProvider) {
     (0, _classCallCheck2.default)(this, SyncBlockStoreManager);
     this.syncBlocks = new Map();
-    this.dataProvider = dataProvider;
   }
   return (0, _createClass2.default)(SyncBlockStoreManager, [{
     key: "setEditorView",
@@ -31,7 +31,7 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
     key: "isSourceBlock",
     value: function isSourceBlock(node) {
       var _this$syncBlocks$get;
-      if (!this.dataProvider || node.type.name !== 'syncBlock') {
+      if (node.type.name !== 'syncBlock') {
         return false;
       }
       var _node$attrs = node.attrs,
@@ -53,6 +53,28 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
     value: function requireConfirmationBeforeDelete() {
       return !!this.confirmationCallback;
     }
+  }, {
+    key: "createSyncBlockNode",
+    value: function createSyncBlockNode() {
+      // TODO: EDITOR-1644 - properly implement creation of the synced block
+      // below is a temporary implementation for the creation of the synced block
+      // the resource id needs to have pageId and content property key in it
+
+      var blockInstanceId = (0, _uuid.default)();
+      var localId = (0, _uuid.default)();
+      var syncBlockNode = {
+        attrs: {
+          resourceId: "ari:cloud:confluence:fake_cloud_id:page/fake_page_id/".concat(blockInstanceId),
+          localId: localId
+        },
+        type: 'syncBlock'
+      };
+      this.syncBlocks.set(syncBlockNode.attrs.resourceId, {
+        resourceId: syncBlockNode.attrs.resourceId,
+        sourceLocalId: syncBlockNode.attrs.localId
+      });
+      return syncBlockNode;
+    }
   }, {
     key: "deleteSyncBlocksWithConfirmation",
     value: function () {

package/dist/cjs/index.js

@@ -15,22 +15,22 @@ Object.defineProperty(exports, "SyncedBlockProvider", {
     return _syncBlockProvider.SyncBlockProvider;
   }
 });
-Object.defineProperty(exports, "createSyncBlockNode", {
+Object.defineProperty(exports, "convertSyncBlockPMNodeToSyncBlockData", {
   enumerable: true,
   get: function get() {
-    return _utils.createSyncBlockNode;
+    return _utils.convertSyncBlockPMNodeToSyncBlockData;
   }
 });
-Object.defineProperty(exports, "createSyncBlockPMNode", {
+Object.defineProperty(exports, "generateSyncBlockSourceUrl", {
   enumerable: true,
   get: function get() {
-    return _utils.createSyncBlockPMNode;
+    return _utils.generateSyncBlockSourceUrl;
   }
 });
-Object.defineProperty(exports, "generateSyncBlockSourceUrl", {
+Object.defineProperty(exports, "getDefaultSyncBlockSchema", {
   enumerable: true,
   get: function get() {
-    return _utils.generateSyncBlockSourceUrl;
+    return _schema.getDefaultSyncBlockSchema;
   }
 });
 Object.defineProperty(exports, "inMemoryFetchProvider", {
@@ -54,4 +54,5 @@ Object.defineProperty(exports, "useFetchDocNode", {
 var _syncBlockProvider = require("./common/syncBlockProvider");
 var _syncBlockStoreManager = require("./common/syncBlockStoreManager");
 var _inMemory = require("./providers/inMemory");
-var _utils = require("./utils/utils");
+var _utils = require("./utils/utils");
+var _schema = require("./common/schema");

package/dist/cjs/utils/utils.js

@@ -1,13 +1,11 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.generateSyncBlockSourceUrl = exports.createSyncBlockPMNode = exports.createSyncBlockNode = void 0;
-var _uuid = _interopRequireDefault(require("uuid"));
+exports.generateSyncBlockSourceUrl = exports.convertSyncBlockPMNodeToSyncBlockData = void 0;
 var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
-var createSyncBlockNode = exports.createSyncBlockNode = function createSyncBlockNode(node) {
+var convertSyncBlockPMNodeToSyncBlockData = exports.convertSyncBlockPMNodeToSyncBlockData = function convertSyncBlockPMNodeToSyncBlockData(node) {
   var includeContent = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
   var transformer = new _editorJsonTransformer.JSONTransformer();
   var toJSON = function toJSON(node) {
@@ -22,17 +20,6 @@ var createSyncBlockNode = exports.createSyncBlockNode = function createSyncBlock
     content: includeContent ? node.content.content.map(toJSON) : undefined
   };
 };
-var createSyncBlockPMNode = exports.createSyncBlockPMNode = function createSyncBlockPMNode(nodeType) {
-  // TODO: EDITOR-1644 - properly implement creation of the synced block
-  // below is a temporary implementation for the creation of the synced block
-  // the resource id needs to have pageId and content property key in it
-  var id = (0, _uuid.default)();
-  var node = nodeType.createChecked({
-    resourceId: id,
-    localId: id
-  }, null);
-  return node;
-};
 var generateSyncBlockSourceUrl = exports.generateSyncBlockSourceUrl = function generateSyncBlockSourceUrl(node) {
   var _node$attrs = node.attrs,
     localId = _node$attrs.localId,

package/dist/es2019/common/schema.js

@@ -0,0 +1,13 @@
+import { createSchema } from '@atlaskit/adf-schema';
+
+/**
+ * We currently do not need any of the new features, like nested tables
+ * Otherwise we could import defaultSchemaConfig from '@atlaskit/adf-schema/schema-default';
+ * @returns
+ */
+export const getDefaultSyncBlockSchema = () => {
+  return createSchema({
+    nodes: ['doc', 'paragraph', 'text', 'bulletList', 'orderedList', 'listItem', 'heading', 'blockquote', 'codeBlock', 'panel', 'rule', 'expand', 'nestedExpand', 'table', 'tableCell', 'tableHeader', 'tableRow', 'date', 'status', 'layoutSection', 'layoutColumn', 'unsupportedBlock', 'unsupportedInline'],
+    marks: ['link', 'em', 'strong', 'strike', 'subsup', 'underline', 'code', 'textColor', 'backgroundColor', 'alignment', 'indentation', 'border', 'unsupportedMark', 'unsupportedNodeAttribute', 'typeAheadQuery']
+  });
+};

package/dist/es2019/common/syncBlockProvider.js

@@ -1,6 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { useEffect, useState } from 'react';
-import { createSyncBlockNode } from '../utils/utils';
+import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 import { SyncBlockDataProvider } from './types';
 export class SyncBlockProvider extends SyncBlockDataProvider {
   constructor(fetchProvider, writeProvider, sourceId) {
@@ -44,7 +44,7 @@ export const useFetchDocNode = (editorView, node, defaultDocNode, provider) => {
       return;
     }
     const interval = window.setInterval(() => {
-      const nodes = [createSyncBlockNode(node, false)];
+      const nodes = [convertSyncBlockPMNodeToSyncBlockData(node, false)];
       provider === null || provider === void 0 ? void 0 : provider.fetchNodesData(nodes).then(data => {
         var _data$;
         if (data && (_data$ = data[0]) !== null && _data$ !== void 0 && _data$.content) {

package/dist/es2019/common/syncBlockStoreManager.js

@@ -1,3 +1,5 @@
+import uuid from 'uuid';
+
 // Do this typedef to make it clear that
 // this is a local identifier for a resource for local use
 
@@ -7,16 +9,15 @@
 // Handles caching, debouncing updates, and publish/subscribe for local changes.
 // Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
 export class SyncBlockStoreManager {
-  constructor(dataProvider) {
+  constructor(_dataProvider) {
     this.syncBlocks = new Map();
-    this.dataProvider = dataProvider;
   }
   setEditorView(editorView) {
     this.editorView = editorView;
   }
   isSourceBlock(node) {
     var _this$syncBlocks$get;
-    if (!this.dataProvider || node.type.name !== 'syncBlock') {
+    if (node.type.name !== 'syncBlock') {
       return false;
     }
     const {
@@ -34,6 +35,26 @@ export class SyncBlockStoreManager {
   requireConfirmationBeforeDelete() {
     return !!this.confirmationCallback;
   }
+  createSyncBlockNode() {
+    // TODO: EDITOR-1644 - properly implement creation of the synced block
+    // below is a temporary implementation for the creation of the synced block
+    // the resource id needs to have pageId and content property key in it
+
+    const blockInstanceId = uuid();
+    const localId = uuid();
+    const syncBlockNode = {
+      attrs: {
+        resourceId: `ari:cloud:confluence:fake_cloud_id:page/fake_page_id/${blockInstanceId}`,
+        localId
+      },
+      type: 'syncBlock'
+    };
+    this.syncBlocks.set(syncBlockNode.attrs.resourceId, {
+      resourceId: syncBlockNode.attrs.resourceId,
+      sourceLocalId: syncBlockNode.attrs.localId
+    });
+    return syncBlockNode;
+  }
   async deleteSyncBlocksWithConfirmation(tr, syncBlockIds) {
     if (this.confirmationCallback) {
       const confirmed = await this.confirmationCallback();

package/dist/es2019/index.js

@@ -3,4 +3,5 @@
 export { SyncBlockProvider as SyncedBlockProvider, useFetchDocNode } from './common/syncBlockProvider';
 export { SyncBlockStoreManager } from './common/syncBlockStoreManager';
 export { inMemoryFetchProvider, inMemoryWriteProvider } from './providers/inMemory';
-export { createSyncBlockNode, createSyncBlockPMNode, generateSyncBlockSourceUrl } from './utils/utils';
+export { convertSyncBlockPMNodeToSyncBlockData, generateSyncBlockSourceUrl } from './utils/utils';
+export { getDefaultSyncBlockSchema } from './common/schema';

package/dist/es2019/utils/utils.js

@@ -1,6 +1,5 @@
-import uuid from 'uuid';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
-export const createSyncBlockNode = (node, includeContent = false) => {
+export const convertSyncBlockPMNodeToSyncBlockData = (node, includeContent = false) => {
   const transformer = new JSONTransformer();
   const toJSON = node => transformer.encodeNode(node);
   return {
@@ -12,17 +11,6 @@ export const createSyncBlockNode = (node, includeContent = false) => {
     content: includeContent ? node.content.content.map(toJSON) : undefined
   };
 };
-export const createSyncBlockPMNode = nodeType => {
-  // TODO: EDITOR-1644 - properly implement creation of the synced block
-  // below is a temporary implementation for the creation of the synced block
-  // the resource id needs to have pageId and content property key in it
-  const id = uuid();
-  const node = nodeType.createChecked({
-    resourceId: id,
-    localId: id
-  }, null);
-  return node;
-};
 export const generateSyncBlockSourceUrl = node => {
   const {
     localId,

package/dist/esm/common/schema.js

@@ -0,0 +1,13 @@
+import { createSchema } from '@atlaskit/adf-schema';
+
+/**
+ * We currently do not need any of the new features, like nested tables
+ * Otherwise we could import defaultSchemaConfig from '@atlaskit/adf-schema/schema-default';
+ * @returns
+ */
+export var getDefaultSyncBlockSchema = function getDefaultSyncBlockSchema() {
+  return createSchema({
+    nodes: ['doc', 'paragraph', 'text', 'bulletList', 'orderedList', 'listItem', 'heading', 'blockquote', 'codeBlock', 'panel', 'rule', 'expand', 'nestedExpand', 'table', 'tableCell', 'tableHeader', 'tableRow', 'date', 'status', 'layoutSection', 'layoutColumn', 'unsupportedBlock', 'unsupportedInline'],
+    marks: ['link', 'em', 'strong', 'strike', 'subsup', 'underline', 'code', 'textColor', 'backgroundColor', 'alignment', 'indentation', 'border', 'unsupportedMark', 'unsupportedNodeAttribute', 'typeAheadQuery']
+  });
+};

package/dist/esm/common/syncBlockProvider.js

@@ -10,7 +10,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 } from 'react';
-import { createSyncBlockNode } from '../utils/utils';
+import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 import { SyncBlockDataProvider } from './types';
 export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
   function SyncBlockProvider(fetchProvider, writeProvider, sourceId) {
@@ -66,7 +66,7 @@ export var useFetchDocNode = function useFetchDocNode(editorView, node, defaultD
       return;
     }
     var interval = window.setInterval(function () {
-      var nodes = [createSyncBlockNode(node, false)];
+      var nodes = [convertSyncBlockPMNodeToSyncBlockData(node, false)];
       provider === null || provider === void 0 || provider.fetchNodesData(nodes).then(function (data) {
         var _data$;
         if (data && (_data$ = data[0]) !== null && _data$ !== void 0 && _data$.content) {

package/dist/esm/common/syncBlockStoreManager.js

@@ -2,6 +2,8 @@ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
+import uuid from 'uuid';
+
 // Do this typedef to make it clear that
 // this is a local identifier for a resource for local use
 
@@ -11,10 +13,9 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 // Handles caching, debouncing updates, and publish/subscribe for local changes.
 // Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
 export var SyncBlockStoreManager = /*#__PURE__*/function () {
-  function SyncBlockStoreManager(dataProvider) {
+  function SyncBlockStoreManager(_dataProvider) {
     _classCallCheck(this, SyncBlockStoreManager);
     this.syncBlocks = new Map();
-    this.dataProvider = dataProvider;
   }
   return _createClass(SyncBlockStoreManager, [{
     key: "setEditorView",
@@ -25,7 +26,7 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
     key: "isSourceBlock",
     value: function isSourceBlock(node) {
       var _this$syncBlocks$get;
-      if (!this.dataProvider || node.type.name !== 'syncBlock') {
+      if (node.type.name !== 'syncBlock') {
         return false;
       }
       var _node$attrs = node.attrs,
@@ -47,6 +48,28 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
     value: function requireConfirmationBeforeDelete() {
       return !!this.confirmationCallback;
     }
+  }, {
+    key: "createSyncBlockNode",
+    value: function createSyncBlockNode() {
+      // TODO: EDITOR-1644 - properly implement creation of the synced block
+      // below is a temporary implementation for the creation of the synced block
+      // the resource id needs to have pageId and content property key in it
+
+      var blockInstanceId = uuid();
+      var localId = uuid();
+      var syncBlockNode = {
+        attrs: {
+          resourceId: "ari:cloud:confluence:fake_cloud_id:page/fake_page_id/".concat(blockInstanceId),
+          localId: localId
+        },
+        type: 'syncBlock'
+      };
+      this.syncBlocks.set(syncBlockNode.attrs.resourceId, {
+        resourceId: syncBlockNode.attrs.resourceId,
+        sourceLocalId: syncBlockNode.attrs.localId
+      });
+      return syncBlockNode;
+    }
   }, {
     key: "deleteSyncBlocksWithConfirmation",
     value: function () {

package/dist/esm/index.js

@@ -3,4 +3,5 @@
 export { SyncBlockProvider as SyncedBlockProvider, useFetchDocNode } from './common/syncBlockProvider';
 export { SyncBlockStoreManager } from './common/syncBlockStoreManager';
 export { inMemoryFetchProvider, inMemoryWriteProvider } from './providers/inMemory';
-export { createSyncBlockNode, createSyncBlockPMNode, generateSyncBlockSourceUrl } from './utils/utils';
+export { convertSyncBlockPMNodeToSyncBlockData, generateSyncBlockSourceUrl } from './utils/utils';
+export { getDefaultSyncBlockSchema } from './common/schema';

package/dist/esm/utils/utils.js

@@ -1,6 +1,5 @@
-import uuid from 'uuid';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
-export var createSyncBlockNode = function createSyncBlockNode(node) {
+export var convertSyncBlockPMNodeToSyncBlockData = function convertSyncBlockPMNodeToSyncBlockData(node) {
   var includeContent = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
   var transformer = new JSONTransformer();
   var toJSON = function toJSON(node) {
@@ -15,17 +14,6 @@ export var createSyncBlockNode = function createSyncBlockNode(node) {
     content: includeContent ? node.content.content.map(toJSON) : undefined
   };
 };
-export var createSyncBlockPMNode = function createSyncBlockPMNode(nodeType) {
-  // TODO: EDITOR-1644 - properly implement creation of the synced block
-  // below is a temporary implementation for the creation of the synced block
-  // the resource id needs to have pageId and content property key in it
-  var id = uuid();
-  var node = nodeType.createChecked({
-    resourceId: id,
-    localId: id
-  }, null);
-  return node;
-};
 export var generateSyncBlockSourceUrl = function generateSyncBlockSourceUrl(node) {
   var _node$attrs = node.attrs,
     localId = _node$attrs.localId,

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

@@ -0,0 +1,6 @@
+/**
+ * We currently do not need any of the new features, like nested tables
+ * Otherwise we could import defaultSchemaConfig from '@atlaskit/adf-schema/schema-default';
+ * @returns
+ */
+export declare const getDefaultSyncBlockSchema: () => import("prosemirror-model").Schema<"doc" | "paragraph" | "text" | "bulletList" | "orderedList" | "listItem" | "heading" | "blockquote" | "codeBlock" | "panel" | "rule" | "expand" | "nestedExpand" | "table" | "tableCell" | "tableHeader" | "tableRow" | "date" | "status" | "layoutSection" | "layoutColumn" | "unsupportedBlock" | "unsupportedInline", "link" | "em" | "strong" | "strike" | "subsup" | "underline" | "code" | "textColor" | "backgroundColor" | "alignment" | "indentation" | "border" | "unsupportedMark" | "unsupportedNodeAttribute" | "typeAheadQuery">;

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

@@ -2,8 +2,7 @@ import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { SyncBlockDataProvider } from './types';
-type ResourceId = string;
+import type { SyncBlockAttrs, SyncBlockDataProvider, SyncBlockNode } from './types';
 export interface SyncBlock {
     /**
      * The local content of the block,
@@ -13,21 +12,17 @@ export interface SyncBlock {
     resourceId: string;
     sourceLocalId: string;
 }
-type SyncBlockAttrs = {
-    localId: string;
-    resourceId: ResourceId;
-};
 type ConfirmationCallback = () => Promise<boolean>;
 export declare class SyncBlockStoreManager {
     private syncBlocks;
-    private dataProvider?;
     private confirmationCallback?;
     private editorView?;
-    constructor(dataProvider?: SyncBlockDataProvider);
+    constructor(_dataProvider?: SyncBlockDataProvider);
     setEditorView(editorView: EditorView | undefined): void;
     isSourceBlock(node: PMNode): boolean;
     registerConfirmationCallback(callback: ConfirmationCallback): () => void;
     requireConfirmationBeforeDelete(): boolean;
+    createSyncBlockNode(): SyncBlockNode;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
 }
 export {};

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

@@ -1,16 +1,18 @@
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
+export type SyncBlockAttrs = {
+    localId: string;
+    resourceId: string;
+};
 export type SyncBlockNode = {
-    attrs: {
-        localId: string;
-        resourceId: string;
-    };
+    attrs: SyncBlockAttrs;
     content?: Array<JSONNode>;
     type: 'syncBlock';
 };
 export type SyncBlockData = {
     content: ADFEntity | undefined;
+    resourceId?: string;
 };
 export interface ADFFetchProvider {
     fetchData: (resourceId: string) => Promise<SyncBlockData>;

package/dist/types/index.d.ts

@@ -2,4 +2,5 @@ export { SyncBlockProvider as SyncedBlockProvider, useFetchDocNode, } from './co
 export { SyncBlockStoreManager } from './common/syncBlockStoreManager';
 export type { SyncBlockDataProvider, ADFFetchProvider, ADFWriteProvider, SyncBlockData, SyncBlockNode, } from './common/types';
 export { inMemoryFetchProvider, inMemoryWriteProvider } from './providers/inMemory';
-export { createSyncBlockNode, createSyncBlockPMNode, generateSyncBlockSourceUrl, } from './utils/utils';
+export { convertSyncBlockPMNodeToSyncBlockData, generateSyncBlockSourceUrl } from './utils/utils';
+export { getDefaultSyncBlockSchema } from './common/schema';

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

@@ -1,5 +1,4 @@
-import type { Node as PMNode, NodeType } from '@atlaskit/editor-prosemirror/model';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { SyncBlockNode } from '../common/types';
-export declare const createSyncBlockNode: (node: PMNode, includeContent?: boolean) => SyncBlockNode;
-export declare const createSyncBlockPMNode: (nodeType: NodeType) => PMNode;
+export declare const convertSyncBlockPMNodeToSyncBlockData: (node: PMNode, includeContent?: boolean) => SyncBlockNode;
 export declare const generateSyncBlockSourceUrl: (node: PMNode) => string;

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

@@ -0,0 +1,6 @@
+/**
+ * We currently do not need any of the new features, like nested tables
+ * Otherwise we could import defaultSchemaConfig from '@atlaskit/adf-schema/schema-default';
+ * @returns
+ */
+export declare const getDefaultSyncBlockSchema: () => import("prosemirror-model").Schema<"doc" | "paragraph" | "text" | "bulletList" | "orderedList" | "listItem" | "heading" | "blockquote" | "codeBlock" | "panel" | "rule" | "expand" | "nestedExpand" | "table" | "tableCell" | "tableHeader" | "tableRow" | "date" | "status" | "layoutSection" | "layoutColumn" | "unsupportedBlock" | "unsupportedInline", "link" | "em" | "strong" | "strike" | "subsup" | "underline" | "code" | "textColor" | "backgroundColor" | "alignment" | "indentation" | "border" | "unsupportedMark" | "unsupportedNodeAttribute" | "typeAheadQuery">;

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

@@ -2,8 +2,7 @@ import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
-import type { SyncBlockDataProvider } from './types';
-type ResourceId = string;
+import type { SyncBlockAttrs, SyncBlockDataProvider, SyncBlockNode } from './types';
 export interface SyncBlock {
     /**
      * The local content of the block,
@@ -13,21 +12,17 @@ export interface SyncBlock {
     resourceId: string;
     sourceLocalId: string;
 }
-type SyncBlockAttrs = {
-    localId: string;
-    resourceId: ResourceId;
-};
 type ConfirmationCallback = () => Promise<boolean>;
 export declare class SyncBlockStoreManager {
     private syncBlocks;
-    private dataProvider?;
     private confirmationCallback?;
     private editorView?;
-    constructor(dataProvider?: SyncBlockDataProvider);
+    constructor(_dataProvider?: SyncBlockDataProvider);
     setEditorView(editorView: EditorView | undefined): void;
     isSourceBlock(node: PMNode): boolean;
     registerConfirmationCallback(callback: ConfirmationCallback): () => void;
     requireConfirmationBeforeDelete(): boolean;
+    createSyncBlockNode(): SyncBlockNode;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
 }
 export {};

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

@@ -1,16 +1,18 @@
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
+export type SyncBlockAttrs = {
+    localId: string;
+    resourceId: string;
+};
 export type SyncBlockNode = {
-    attrs: {
-        localId: string;
-        resourceId: string;
-    };
+    attrs: SyncBlockAttrs;
     content?: Array<JSONNode>;
     type: 'syncBlock';
 };
 export type SyncBlockData = {
     content: ADFEntity | undefined;
+    resourceId?: string;
 };
 export interface ADFFetchProvider {
     fetchData: (resourceId: string) => Promise<SyncBlockData>;

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

@@ -2,4 +2,5 @@ export { SyncBlockProvider as SyncedBlockProvider, useFetchDocNode, } from './co
 export { SyncBlockStoreManager } from './common/syncBlockStoreManager';
 export type { SyncBlockDataProvider, ADFFetchProvider, ADFWriteProvider, SyncBlockData, SyncBlockNode, } from './common/types';
 export { inMemoryFetchProvider, inMemoryWriteProvider } from './providers/inMemory';
-export { createSyncBlockNode, createSyncBlockPMNode, generateSyncBlockSourceUrl, } from './utils/utils';
+export { convertSyncBlockPMNodeToSyncBlockData, generateSyncBlockSourceUrl } from './utils/utils';
+export { getDefaultSyncBlockSchema } from './common/schema';

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

@@ -1,5 +1,4 @@
-import type { Node as PMNode, NodeType } from '@atlaskit/editor-prosemirror/model';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { SyncBlockNode } from '../common/types';
-export declare const createSyncBlockNode: (node: PMNode, includeContent?: boolean) => SyncBlockNode;
-export declare const createSyncBlockPMNode: (nodeType: NodeType) => PMNode;
+export declare const convertSyncBlockPMNodeToSyncBlockData: (node: PMNode, includeContent?: boolean) => SyncBlockNode;
 export declare const generateSyncBlockSourceUrl: (node: PMNode) => string;

package/package.json

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