@atlaskit/editor-synced-block-provider 2.7.4 → 2.9.0

package/dist/esm/utils/blockService.js

@@ -0,0 +1,161 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
+import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+import _inherits from "@babel/runtime/helpers/inherits";
+import _wrapNativeSuper from "@babel/runtime/helpers/wrapNativeSuper";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+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; })(); }
+var COMMON_HEADERS = {
+  'Content-Type': 'application/json',
+  Accept: 'application/json'
+};
+var BLOCK_SERVICE_API_URL = '/gateway/api/blocks/v1';
+export var BlockError = /*#__PURE__*/function (_Error) {
+  function BlockError(status) {
+    var _this;
+    _classCallCheck(this, BlockError);
+    _this = _callSuper(this, BlockError, ["Block error"]);
+    _this.status = status;
+    return _this;
+  }
+  _inherits(BlockError, _Error);
+  return _createClass(BlockError);
+}( /*#__PURE__*/_wrapNativeSuper(Error));
+export var getSyncedBlockContent = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref) {
+    var blockAri, response;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          blockAri = _ref.blockAri;
+          _context.next = 3;
+          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(blockAri), {
+            method: 'GET',
+            headers: COMMON_HEADERS
+          });
+        case 3:
+          response = _context.sent;
+          if (response.ok) {
+            _context.next = 6;
+            break;
+          }
+          throw new BlockError(response.status);
+        case 6:
+          _context.next = 8;
+          return response.json();
+        case 8:
+          return _context.abrupt("return", _context.sent);
+        case 9:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee);
+  }));
+  return function getSyncedBlockContent(_x) {
+    return _ref2.apply(this, arguments);
+  };
+}();
+export var deleteSyncedBlock = /*#__PURE__*/function () {
+  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(_ref3) {
+    var blockAri, response;
+    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          blockAri = _ref3.blockAri;
+          _context2.next = 3;
+          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(blockAri), {
+            method: 'DELETE',
+            headers: COMMON_HEADERS
+          });
+        case 3:
+          response = _context2.sent;
+          if (response.ok) {
+            _context2.next = 6;
+            break;
+          }
+          throw new BlockError(response.status);
+        case 6:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  }));
+  return function deleteSyncedBlock(_x2) {
+    return _ref4.apply(this, arguments);
+  };
+}();
+export var updateSyncedBlock = /*#__PURE__*/function () {
+  var _ref6 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(_ref5) {
+    var blockAri, content, response;
+    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
+        case 0:
+          blockAri = _ref5.blockAri, content = _ref5.content;
+          _context3.next = 3;
+          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(blockAri), {
+            method: 'PUT',
+            headers: COMMON_HEADERS,
+            body: JSON.stringify({
+              content: content
+            })
+          });
+        case 3:
+          response = _context3.sent;
+          if (response.ok) {
+            _context3.next = 6;
+            break;
+          }
+          throw new BlockError(response.status);
+        case 6:
+        case "end":
+          return _context3.stop();
+      }
+    }, _callee3);
+  }));
+  return function updateSyncedBlock(_x3) {
+    return _ref6.apply(this, arguments);
+  };
+}();
+export var createSyncedBlock = /*#__PURE__*/function () {
+  var _ref8 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee4(_ref7) {
+    var blockAri, blockInstanceId, sourceAri, product, content, response;
+    return _regeneratorRuntime.wrap(function _callee4$(_context4) {
+      while (1) switch (_context4.prev = _context4.next) {
+        case 0:
+          blockAri = _ref7.blockAri, blockInstanceId = _ref7.blockInstanceId, sourceAri = _ref7.sourceAri, product = _ref7.product, content = _ref7.content;
+          _context4.next = 3;
+          return fetch("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(blockAri), {
+            method: 'POST',
+            headers: COMMON_HEADERS,
+            body: JSON.stringify({
+              blockInstanceId: blockInstanceId,
+              sourceAri: sourceAri,
+              product: product,
+              content: content
+            })
+          });
+        case 3:
+          response = _context4.sent;
+          if (response.ok) {
+            _context4.next = 6;
+            break;
+          }
+          throw new BlockError(response.status);
+        case 6:
+          _context4.next = 8;
+          return response.json();
+        case 8:
+          return _context4.abrupt("return", _context4.sent);
+        case 9:
+        case "end":
+          return _context4.stop();
+      }
+    }, _callee4);
+  }));
+  return function createSyncedBlock(_x4) {
+    return _ref8.apply(this, arguments);
+  };
+}();

package/dist/types/index.d.ts

@@ -4,11 +4,12 @@ export type { SyncBlockData, SyncBlockNode } from './common/types';
 export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } from './hooks/useFetchSyncBlockData';
 export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
+export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
 export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, } from './providers/types';
 export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { getConfluencePageAri, getPageIdAndTypeFromAri } from './utils/ari';
+export { blockResourceIdFromSourceAndLocalId, getConfluencePageAri, getLocalIdFromAri, getLocalIdFromResourceId, getPageARIFromResourceId, getPageIdAndTypeFromAri, resourceIdFromSourceAndLocalId, } from './utils/ari';
 export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, } from './utils/utils';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';

package/dist/types/providers/block-service/blockServiceAPI.d.ts

@@ -0,0 +1,21 @@
+import { type SyncBlockData } from '../../common/types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+/**
+ * ADFFetchProvider implementation that fetches synced block data from Block Service API
+ */
+declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
+    fetchData(resourceId: string): Promise<SyncBlockInstance>;
+}
+/**
+ * ADFWriteProvider implementation that writes synced block data to Block Service API
+ */
+declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
+    writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
+    deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
+    generateResourceId(sourceId: string, localId: string): string;
+}
+export declare const useMemoizedBlockServiceAPIProviders: () => {
+    fetchProvider: BlockServiceADFFetchProvider;
+    writeProvider: BlockServiceADFWriteProvider;
+};
+export {};

package/dist/types/providers/confluence/confluenceContentAPI.d.ts

@@ -24,6 +24,7 @@ declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     private createNewContentProperty;
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
+    generateResourceId(sourceId: string, localId: string): string;
 }
 /**
  * Convenience function to create providers with default content property key

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

@@ -22,5 +22,6 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     getSourceId(): string;
     retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
+    generateResourceId(sourceId: string, localId: string): string;
 }
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;

package/dist/types/providers/types.d.ts

@@ -28,6 +28,7 @@ export interface ADFFetchProvider {
 }
 export interface ADFWriteProvider {
     deleteData: (resourceId: string) => Promise<DeleteSyncBlockResult>;
+    generateResourceId: (sourceId: string, localId: string) => ResourceId;
     writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
@@ -35,6 +36,13 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
     abstract retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
+    /**
+     * Generates a resource ID from a source ID and local ID.
+     * @param sourceId - The source document ID (e.g., page ARI)
+     * @param localId - The local block ID (usually a UUID)
+     * @returns The generated resource ID
+     */
+    abstract generateResourceId(sourceId: ResourceId, localId: string): ResourceId;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
 export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -6,5 +6,19 @@ 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;
 export declare const resourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;
+/**
+ * For the following functions, they are used for the block service API provider.
+ * The resourceId/blockResourceId always refers to the block ARI.
+ */
+/**
+ * @param sourceId - the ARI of the document. E.G ari:cloud:confluence:cloudId:page/pageId
+ * @param localId - the localId of the block node. A randomly generated UUID
+ * @returns the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId
+ */
+export declare const blockResourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;
+/**
+ * @param ari - the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId
+ * @returns the localId of the block node. A randomly generated UUID
+ */
+export declare const getLocalIdFromResourceId: (ari: string) => string;

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

@@ -0,0 +1,39 @@
+export type BlockProduct = 'confluence-page' | 'jira-work-item';
+export type BlockContentResponse = {
+    blockAri: string;
+    blockInstanceId: string;
+    content: string;
+    contentUpdatedAt: number;
+    createdAt: number;
+    createdBy: string;
+    isSynced: boolean;
+    product: BlockProduct;
+    sourceAri: string;
+    status: 'active' | 'deleted';
+    version: number;
+};
+export type GetSyncedBlockContentRequest = {
+    blockAri: string;
+};
+export type DeleteSyncedBlockRequest = {
+    blockAri: string;
+};
+export type UpdateSyncedBlockRequest = {
+    blockAri: string;
+    content: string;
+};
+export type CreateSyncedBlockRequest = {
+    blockAri: string;
+    blockInstanceId: string;
+    content: string;
+    product: string;
+    sourceAri: string;
+};
+export declare class BlockError extends Error {
+    readonly status: number;
+    constructor(status: number);
+}
+export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
+export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
+export declare const updateSyncedBlock: ({ blockAri, content, }: UpdateSyncedBlockRequest) => Promise<void>;
+export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;

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

@@ -4,11 +4,12 @@ export type { SyncBlockData, SyncBlockNode } from './common/types';
 export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } from './hooks/useFetchSyncBlockData';
 export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
+export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
 export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, } from './providers/types';
 export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { getConfluencePageAri, getPageIdAndTypeFromAri } from './utils/ari';
+export { blockResourceIdFromSourceAndLocalId, getConfluencePageAri, getLocalIdFromAri, getLocalIdFromResourceId, getPageARIFromResourceId, getPageIdAndTypeFromAri, resourceIdFromSourceAndLocalId, } from './utils/ari';
 export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, } from './utils/utils';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';

package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts

@@ -0,0 +1,21 @@
+import { type SyncBlockData } from '../../common/types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+/**
+ * ADFFetchProvider implementation that fetches synced block data from Block Service API
+ */
+declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
+    fetchData(resourceId: string): Promise<SyncBlockInstance>;
+}
+/**
+ * ADFWriteProvider implementation that writes synced block data to Block Service API
+ */
+declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
+    writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
+    deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
+    generateResourceId(sourceId: string, localId: string): string;
+}
+export declare const useMemoizedBlockServiceAPIProviders: () => {
+    fetchProvider: BlockServiceADFFetchProvider;
+    writeProvider: BlockServiceADFWriteProvider;
+};
+export {};

package/dist/types-ts4.5/providers/confluence/confluenceContentAPI.d.ts

@@ -24,6 +24,7 @@ declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     private createNewContentProperty;
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
+    generateResourceId(sourceId: string, localId: string): string;
 }
 /**
  * Convenience function to create providers with default content property key

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

@@ -22,5 +22,6 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     getSourceId(): string;
     retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
+    generateResourceId(sourceId: string, localId: string): string;
 }
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;

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

@@ -28,6 +28,7 @@ export interface ADFFetchProvider {
 }
 export interface ADFWriteProvider {
     deleteData: (resourceId: string) => Promise<DeleteSyncBlockResult>;
+    generateResourceId: (sourceId: string, localId: string) => ResourceId;
     writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
@@ -35,6 +36,13 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
     abstract retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
+    /**
+     * Generates a resource ID from a source ID and local ID.
+     * @param sourceId - The source document ID (e.g., page ARI)
+     * @param localId - The local block ID (usually a UUID)
+     * @returns The generated resource ID
+     */
+    abstract generateResourceId(sourceId: ResourceId, localId: string): ResourceId;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
 export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -6,5 +6,19 @@ 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;
 export declare const resourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;
+/**
+ * For the following functions, they are used for the block service API provider.
+ * The resourceId/blockResourceId always refers to the block ARI.
+ */
+/**
+ * @param sourceId - the ARI of the document. E.G ari:cloud:confluence:cloudId:page/pageId
+ * @param localId - the localId of the block node. A randomly generated UUID
+ * @returns the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId
+ */
+export declare const blockResourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;
+/**
+ * @param ari - the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId
+ * @returns the localId of the block node. A randomly generated UUID
+ */
+export declare const getLocalIdFromResourceId: (ari: string) => string;

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

@@ -0,0 +1,39 @@
+export type BlockProduct = 'confluence-page' | 'jira-work-item';
+export type BlockContentResponse = {
+    blockAri: string;
+    blockInstanceId: string;
+    content: string;
+    contentUpdatedAt: number;
+    createdAt: number;
+    createdBy: string;
+    isSynced: boolean;
+    product: BlockProduct;
+    sourceAri: string;
+    status: 'active' | 'deleted';
+    version: number;
+};
+export type GetSyncedBlockContentRequest = {
+    blockAri: string;
+};
+export type DeleteSyncedBlockRequest = {
+    blockAri: string;
+};
+export type UpdateSyncedBlockRequest = {
+    blockAri: string;
+    content: string;
+};
+export type CreateSyncedBlockRequest = {
+    blockAri: string;
+    blockInstanceId: string;
+    content: string;
+    product: string;
+    sourceAri: string;
+};
+export declare class BlockError extends Error {
+    readonly status: number;
+    constructor(status: number);
+}
+export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
+export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
+export declare const updateSyncedBlock: ({ blockAri, content, }: UpdateSyncedBlockRequest) => Promise<void>;
+export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;

package/package.json

@@ -25,11 +25,12 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/adf-schema": "^51.3.2",
-		"@atlaskit/adf-utils": "^19.25.0",
+		"@atlaskit/adf-utils": "^19.26.0",
 		"@atlaskit/css": "^0.15.0",
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/node-data-provider": "^7.5.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^16.1.0",
 		"@atlaskit/tokens": "^8.0.0",
 		"@babel/runtime": "^7.0.0",
@@ -82,11 +83,16 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.7.4",
+	"version": "2.9.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
+	},
+	"platform-feature-flags": {
+		"platform_editor_synced_block_provider_use_block_service": {
+			"type": "boolean"
+		}
 	}
 }