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

package/dist/es2019/providers/confluenceContentAPI.js

@@ -1,7 +1,8 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { useMemo } from 'react';
-import { getLocalIdFromAri, getPageIdFromAri, resourceIdFromSourceAndLocalId } from '../utils/ari';
+import { getLocalIdFromAri, getPageIdAndTypeFromAri, resourceIdFromSourceAndLocalId } from '../utils/ari';
 import { getContentProperty, createContentProperty, updateContentProperty } from '../utils/contentProperty';
+import { isBlogPageType } from '../utils/utils';
 
 /**
  * Configuration for Content API providers
@@ -12,17 +13,19 @@ const getContentPropertyKey = (contentPropertyKey, localId) => {
 };
 const parseSyncedBlockContentPropertyValue = value => {
   try {
-    if (typeof value === 'string') {
-      return JSON.parse(value);
+    if (value !== '') {
+      const parsedValue = JSON.parse(value);
+      if (parsedValue.content) {
+        return parsedValue;
+      }
     }
-    return value;
   } catch (error) {
     // eslint-disable-next-line no-console
     console.error('Failed to parse synced block content:', error);
-    return {
-      content: undefined
-    };
   }
+  return {
+    content: undefined
+  };
 };
 
 /**
@@ -33,17 +36,28 @@ class ConfluenceADFFetchProvider {
     this.config = config;
   }
   async fetchData(resourceId) {
-    var _contentProperty$data, _contentProperty$data2;
-    const pageId = getPageIdFromAri(resourceId);
+    const {
+      id: pageId,
+      type: pageType
+    } = getPageIdAndTypeFromAri(resourceId);
     const localId = getLocalIdFromAri(resourceId);
     const key = getContentPropertyKey(this.config.contentPropertyKey, localId);
     const options = {
       pageId,
       key,
-      cloudId: this.config.cloudId
+      cloudId: this.config.cloudId,
+      pageType
     };
-    const contentProperty = await getContentProperty(options);
-    const value = (_contentProperty$data = contentProperty.data.confluence.page.properties) === null || _contentProperty$data === void 0 ? void 0 : (_contentProperty$data2 = _contentProperty$data[0]) === null || _contentProperty$data2 === void 0 ? void 0 : _contentProperty$data2.value;
+    let value;
+    if (isBlogPageType(pageType)) {
+      var _contentProperty$data, _contentProperty$data2;
+      const contentProperty = await getContentProperty(options);
+      value = (_contentProperty$data = contentProperty.data.confluence.blogPost.properties) === null || _contentProperty$data === void 0 ? void 0 : (_contentProperty$data2 = _contentProperty$data[0]) === null || _contentProperty$data2 === void 0 ? void 0 : _contentProperty$data2.value;
+    } else {
+      var _contentProperty$data3, _contentProperty$data4;
+      const contentProperty = await getContentProperty(options);
+      value = (_contentProperty$data3 = contentProperty.data.confluence.page.properties) === null || _contentProperty$data3 === void 0 ? void 0 : (_contentProperty$data4 = _contentProperty$data3[0]) === null || _contentProperty$data4 === void 0 ? void 0 : _contentProperty$data4.value;
+    }
     if (!value) {
       throw new Error('Content property value does not exist');
     }
@@ -63,24 +77,39 @@ class ConfluenceADFFetchProvider {
  */
 class ConfluenceADFWriteProvider {
   constructor(config) {
-    _defineProperty(this, "createNewContentProperty", async (pageId, key, value) => {
-      var _contentProperty$data3;
-      const contentProperty = await createContentProperty({
+    _defineProperty(this, "createNewContentProperty", async (pageId, key, value, pageType) => {
+      const options = {
         pageId,
         key,
         value,
-        cloudId: this.config.cloudId
-      });
-      if (((_contentProperty$data3 = contentProperty.data.confluence.createPageProperty.pageProperty) === null || _contentProperty$data3 === void 0 ? void 0 : _contentProperty$data3.key) === key) {
-        return key;
+        cloudId: this.config.cloudId,
+        pageType
+      };
+      if (isBlogPageType(pageType)) {
+        var _contentProperty$data5;
+        const contentProperty = await createContentProperty(options);
+        if (((_contentProperty$data5 = contentProperty.data.confluence.createBlogPostProperty.blogPostProperty) === null || _contentProperty$data5 === void 0 ? void 0 : _contentProperty$data5.key) === key) {
+          return key;
+        } else {
+          throw new Error('Failed to create blog post content property');
+        }
       } else {
-        throw new Error('Failed to create content property');
+        var _contentProperty$data6;
+        const contentProperty = await createContentProperty(options);
+        if (((_contentProperty$data6 = contentProperty.data.confluence.createPageProperty.pageProperty) === null || _contentProperty$data6 === void 0 ? void 0 : _contentProperty$data6.key) === key) {
+          return key;
+        } else {
+          throw new Error('Failed to create page content property');
+        }
       }
     });
     this.config = config;
   }
   async writeData(data) {
-    const pageId = getPageIdFromAri(data.resourceId);
+    const {
+      id: pageId,
+      type: pageType
+    } = getPageIdAndTypeFromAri(data.resourceId);
     if (data.sourceDocumentAri && data.resourceId !== resourceIdFromSourceAndLocalId(data.sourceDocumentAri, data.localId)) {
       return Promise.reject('Resource ARI differs from source document ARI');
     }
@@ -88,27 +117,41 @@ class ConfluenceADFWriteProvider {
       content: data.content
     });
     if (data.resourceId) {
-      var _contentProperty$data4;
       // Update existing content property
       const localId = getLocalIdFromAri(data.resourceId);
       const key = getContentPropertyKey(this.config.contentPropertyKey, localId);
-      const contentProperty = await updateContentProperty({
+      const options = {
         pageId,
         key,
         value: syncedBlockValue,
-        cloudId: this.config.cloudId
-      });
-      if (((_contentProperty$data4 = contentProperty.data.confluence.updateValuePageProperty.pageProperty) === null || _contentProperty$data4 === void 0 ? void 0 : _contentProperty$data4.key) === key) {
-        return key;
-      } else if (contentProperty.data.confluence.updateValuePageProperty.pageProperty === null) {
-        return this.createNewContentProperty(pageId, key, syncedBlockValue);
+        cloudId: this.config.cloudId,
+        pageType
+      };
+      if (isBlogPageType(pageType)) {
+        var _contentProperty$data7;
+        const contentProperty = await updateContentProperty(options);
+        if (((_contentProperty$data7 = contentProperty.data.confluence.updateValueBlogPostProperty.blogPostProperty) === null || _contentProperty$data7 === void 0 ? void 0 : _contentProperty$data7.key) === key) {
+          return key;
+        } else if (contentProperty.data.confluence.updateValueBlogPostProperty.blogPostProperty === null) {
+          return this.createNewContentProperty(pageId, key, syncedBlockValue, pageType);
+        } else {
+          throw new Error('Failed to update blog post content property');
+        }
       } else {
-        throw new Error('Failed to update content property');
+        var _contentProperty$data8;
+        const contentProperty = await updateContentProperty(options);
+        if (((_contentProperty$data8 = contentProperty.data.confluence.updateValuePageProperty.pageProperty) === null || _contentProperty$data8 === void 0 ? void 0 : _contentProperty$data8.key) === key) {
+          return key;
+        } else if (contentProperty.data.confluence.updateValuePageProperty.pageProperty === null) {
+          return this.createNewContentProperty(pageId, key, syncedBlockValue, pageType);
+        } else {
+          throw new Error('Failed to update content property');
+        }
       }
     } else {
       // Create new content property
       const key = getContentPropertyKey(this.config.contentPropertyKey, data.localId);
-      return this.createNewContentProperty(pageId, key, syncedBlockValue);
+      return this.createNewContentProperty(pageId, key, syncedBlockValue, pageType);
     }
   }
 }

package/dist/es2019/utils/ari.js

@@ -1,37 +1,40 @@
-export const getConfluencePageAri = (pageId, cloudId) => `ari:cloud:confluence:${cloudId}:page/${pageId}`;
-export const getPageIdFromAri = ari => {
-  // eslint-disable-next-line require-unicode-regexp
-  const match = ari.match(/ari:cloud:confluence:[^:]+:page\/(\d+)/);
-  if (match !== null && match !== void 0 && match[1]) {
-    return match[1];
+/* eslint-disable require-unicode-regexp  */
+
+export const getConfluencePageAri = (pageId, cloudId, pageType = 'page') => `ari:cloud:confluence:${cloudId}:${pageType}/${pageId}`;
+export const getPageIdAndTypeFromAri = ari => {
+  const match = ari.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/(\d+)/);
+  if (match !== null && match !== void 0 && match[2]) {
+    return {
+      type: match[1],
+      id: match[2]
+    };
   }
   throw new Error(`Invalid page ARI: ${ari}`);
 };
-
-/**
- *
- * @param ari ari:cloud:confluence:<cloudId>:page/<pageId>/<localId>
- * @returns
- */
 export const getLocalIdFromAri = ari => {
-  // eslint-disable-next-line require-unicode-regexp
-  const match = ari.match(/ari:cloud:confluence:[^:]+:page\/\d+\/([a-zA-Z0-9-]+)/);
-  if (match !== null && match !== void 0 && match[1]) {
-    return match[1];
+  const match = ari.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/\d+\/([a-zA-Z0-9-]+)/);
+  if (match !== null && match !== void 0 && match[2]) {
+    return match[2];
   }
   throw new Error(`Invalid page ARI: ${ari}`);
 };
 export const getPageARIFromResourceId = resourceId => {
-  // eslint-disable-next-line require-unicode-regexp
-  const match = resourceId.match(/(ari:cloud:confluence:[^:]+:page\/\d+)\/([a-zA-Z0-9-]+)$/);
+  const match = resourceId.match(/(ari:cloud:confluence:[^:]+:(page|blogpost)\/\d+)\/([a-zA-Z0-9-]+)$/);
   if (match !== null && match !== void 0 && match[1]) {
     return match[1];
   }
   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 => {
-  // eslint-disable-next-line require-unicode-regexp
   const match = ari.match(/ari:cloud:confluence:[^:]+:content\/([^/]+)/);
   if (match) {
     return match[1];

package/dist/es2019/utils/contentProperty.js

@@ -1,4 +1,5 @@
 import { getConfluencePageAri } from './ari';
+import { isBlogPageType } from './utils';
 const COMMON_HEADERS = {
   'Content-Type': 'application/json',
   Accept: 'application/json'
@@ -16,7 +17,7 @@ const UPDATE_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_UPDATE';
  * @param key
  * @returns
  */
-const GET_QUERY = `query ${GET_OPERATION_NAME} ($id: ID!, $keys: [String]!) {
+const GET_PAGE_QUERY = `query ${GET_OPERATION_NAME} ($id: ID!, $keys: [String]!) {
 					confluence {
 						page (id: $id) {
 							properties(keys: $keys) {
@@ -27,6 +28,23 @@ const GET_QUERY = `query ${GET_OPERATION_NAME} ($id: ID!, $keys: [String]!) {
 					}
 				}`;
 
+/**
+ * Query to get the blog page property by key
+ * @param documentARI
+ * @param key
+ * @returns
+ */
+const GET_BLOG_QUERY = `query ${GET_OPERATION_NAME} ($id: ID!, $keys: [String]!) {
+	confluence {
+		blogPost (id: $id) {
+			properties(keys: $keys) {
+				key,
+				value
+			}
+		}
+	}
+}`;
+
 /**
  * Query to create a page property with key and value
  * @param documentARI
@@ -34,7 +52,7 @@ const GET_QUERY = `query ${GET_OPERATION_NAME} ($id: ID!, $keys: [String]!) {
  * @param value
  * @returns
  */
-const CREATE_QUERY = `mutation ${CREATE_OPERATION_NAME} ($input: ConfluenceCreatePagePropertyInput!){
+const CREATE_PAGE_QUERY = `mutation ${CREATE_OPERATION_NAME} ($input: ConfluenceCreatePagePropertyInput!){
 						confluence {
 							createPageProperty(input: $input) {
 								pageProperty {
@@ -45,6 +63,24 @@ const CREATE_QUERY = `mutation ${CREATE_OPERATION_NAME} ($input: ConfluenceCreat
 						}
 					}`;
 
+/**
+ * Query to create a blog page property with key and value
+ * @param documentARI
+ * @param key
+ * @param value
+ * @returns
+ */
+const CREATE_BLOG_QUERY = `mutation ${CREATE_OPERATION_NAME} ($input: ConfluenceCreateBlogPostPropertyInput!){
+	confluence {
+		createBlogPostProperty(input: $input) {
+			blogPostProperty {
+				key,
+				value
+			}
+		}
+	}
+}`;
+
 /**
  * Query to update a page property with key and value without bumping the version
  * @param documentARI
@@ -52,7 +88,7 @@ const CREATE_QUERY = `mutation ${CREATE_OPERATION_NAME} ($input: ConfluenceCreat
  * @param value
  * @returns
  */
-const UPDATE_QUERY = `mutation ${UPDATE_OPERATION_NAME} ($input: ConfluenceUpdateValuePagePropertyInput!) {
+const UPDATE_PAGE_QUERY = `mutation ${UPDATE_OPERATION_NAME} ($input: ConfluenceUpdateValuePagePropertyInput!) {
 						confluence {
 							updateValuePageProperty(input: $input) {
 								pageProperty {
@@ -62,14 +98,34 @@ const UPDATE_QUERY = `mutation ${UPDATE_OPERATION_NAME} ($input: ConfluenceUpdat
 							}
 						}
 					}`;
+
+/**
+ * Query to update a blog page property with key and value without bumping the version
+ * @param documentARI
+ * @param key
+ * @param value
+ * @returns
+ */
+const UPDATE_BLOG_QUERY = `mutation ${UPDATE_OPERATION_NAME} ($input: ConfluenceUpdateValueBlogPostPropertyInput!) {
+	confluence {
+		updateValueBlogPostProperty(input: $input) {
+			blogPostProperty {
+				key,
+				value
+			}
+		}
+	}
+}`;
 export const getContentProperty = async ({
   pageId,
   key,
-  cloudId
+  cloudId,
+  pageType
 }) => {
-  const documentARI = getConfluencePageAri(pageId, cloudId);
+  const documentARI = getConfluencePageAri(pageId, cloudId, pageType);
+  const isBlog = isBlogPageType(pageType);
   const bodyData = {
-    query: GET_QUERY,
+    query: isBlog ? GET_BLOG_QUERY : GET_PAGE_QUERY,
     operationName: GET_OPERATION_NAME,
     variables: {
       id: documentARI,
@@ -87,26 +143,42 @@ export const getContentProperty = async ({
   if (!response.ok) {
     throw new Error(`Failed to get content property: ${response.statusText}`);
   }
-  const contentProperty = await response.json();
-  return contentProperty;
+  return await response.json();
 };
 export const updateContentProperty = async ({
   pageId,
   key,
   value,
-  cloudId
+  cloudId,
+  pageType
 }) => {
-  const documentARI = getConfluencePageAri(pageId, cloudId);
+  const documentARI = getConfluencePageAri(pageId, cloudId, pageType);
+  const isBlog = isBlogPageType(pageType);
+  const useSameVersion = {
+    useSameVersion: true
+  };
+  let input = {
+    ...(isBlog ? {
+      blogPostId: documentARI
+    } : {
+      pageId: documentARI
+    }),
+    key,
+    value
+  };
+
+  // Blog content properties don't support the useSameVersion flag at the moment
+  if (!isBlog) {
+    input = {
+      ...input,
+      ...useSameVersion
+    };
+  }
   const bodyData = {
-    query: UPDATE_QUERY,
+    query: isBlog ? UPDATE_BLOG_QUERY : UPDATE_PAGE_QUERY,
     operationName: UPDATE_OPERATION_NAME,
     variables: {
-      input: {
-        pageId: documentARI,
-        key,
-        value,
-        useSameVersion: true
-      }
+      input
     }
   };
   const response = await fetch(GRAPHQL_ENDPOINT, {
@@ -120,25 +192,30 @@ export const updateContentProperty = async ({
   if (!response.ok) {
     throw new Error(`Failed to update content property: ${response.statusText}`);
   }
-  const contentProperty = await response.json();
-  return contentProperty;
+  return await response.json();
 };
 export const createContentProperty = async ({
   pageId,
   key,
   value,
-  cloudId
+  cloudId,
+  pageType
 }) => {
-  const documentARI = getConfluencePageAri(pageId, cloudId);
+  const documentARI = getConfluencePageAri(pageId, cloudId, pageType);
+  const isBlog = isBlogPageType(pageType);
 
   // eslint-disable-next-line require-unicode-regexp
   const escapedValue = value.replace(/"/g, '\\"');
   const bodyData = {
-    query: CREATE_QUERY,
+    query: isBlog ? CREATE_BLOG_QUERY : CREATE_PAGE_QUERY,
     operationName: CREATE_OPERATION_NAME,
     variables: {
       input: {
-        pageId: documentARI,
+        ...(isBlog ? {
+          blogPostId: documentARI
+        } : {
+          pageId: documentARI
+        }),
         key,
         value: escapedValue
       }
@@ -155,6 +232,5 @@ export const createContentProperty = async ({
   if (!response.ok) {
     throw new Error(`Failed to create content property: ${response.statusText}`);
   }
-  const contentProperty = await response.json();
-  return contentProperty;
+  return await response.json();
 };

package/dist/es2019/utils/utils.js

@@ -10,4 +10,7 @@ export const convertSyncBlockPMNodeToSyncBlockData = (node, includeContent = fal
     },
     content: includeContent ? node.content.content.map(toJSON) : undefined
   };
+};
+export const isBlogPageType = pageType => {
+  return pageType === 'blogpost';
 };