@atlaskit/editor-synced-block-provider 3.12.0 → 3.13.0

package/dist/cjs/utils/experienceTracking.js

@@ -0,0 +1,119 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getSaveSourceExperience = exports.getSaveReferenceExperience = exports.getFetchSourceInfoExperience = exports.getFetchExperience = exports.getDeleteSourceExperience = exports.getCreateSourceExperience = exports.createExperienceDispatcher = void 0;
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _experiences = require("@atlaskit/editor-common/experiences");
+var TIMEOUT_DURATION = 30000;
+var createExperienceDispatcher = exports.createExperienceDispatcher = function createExperienceDispatcher(fireAnalyticsEvent) {
+  return function (payload) {
+    // Runtime type guard - only forward experience events
+    if (payload.action === _analytics.ACTION.EXPERIENCE_MEASURED || payload.action === _analytics.ACTION.EXPERIENCE_SAMPLED) {
+      fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 || fireAnalyticsEvent(payload);
+    }
+  };
+};
+
+/**
+ * This experience tracks when a source sync block is saved to the BE.
+ *
+ * Start: When the flush source sync block function is called.
+ * Success: When the sync block save is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the sync block being successfully saved
+ */
+var getSaveSourceExperience = exports.getSaveSourceExperience = function getSaveSourceExperience(fireAnalyticsEvent) {
+  return new _experiences.Experience(_experiences.EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: _analytics.ACTION.SYNCED_BLOCK_UPDATE,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new _experiences.ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};
+
+/**
+ * This experience tracks when a reference sync block is saved to the BE.
+ *
+ * Start: When the flush sync block function is called.
+ * Success: When the sync block save is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the sync block being successfully saved
+ */
+var getSaveReferenceExperience = exports.getSaveReferenceExperience = function getSaveReferenceExperience(fireAnalyticsEvent) {
+  return new _experiences.Experience(_experiences.EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: _analytics.ACTION.REFERENCE_SYNCED_BLOCK_UPDATE,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new _experiences.ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};
+
+/**
+ * This experience tracks when a reference sync block data is fetched from the BE.
+ *
+ * Start: When the fetchNodesData function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+var getFetchExperience = exports.getFetchExperience = function getFetchExperience(fireAnalyticsEvent) {
+  return new _experiences.Experience(_experiences.EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: _analytics.ACTION.SYNCED_BLOCK_FETCH,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new _experiences.ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};
+
+/**
+ * This experience tracks when a reference sync block source info data (title, url) is fetched from the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+var getFetchSourceInfoExperience = exports.getFetchSourceInfoExperience = function getFetchSourceInfoExperience(fireAnalyticsEvent) {
+  return new _experiences.Experience(_experiences.EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: _analytics.ACTION.SYNCED_BLOCK_GET_SOURCE_INFO,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new _experiences.ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};
+
+/**
+ * This experience tracks when a source sync block is deleted from the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+var getDeleteSourceExperience = exports.getDeleteSourceExperience = function getDeleteSourceExperience(fireAnalyticsEvent) {
+  return new _experiences.Experience(_experiences.EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: _analytics.ACTION.SYNCED_BLOCK_DELETE,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new _experiences.ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};
+
+/**
+ * This experience tracks when a source sync block is created and registered to the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+var getCreateSourceExperience = exports.getCreateSourceExperience = function getCreateSourceExperience(fireAnalyticsEvent) {
+  return new _experiences.Experience(_experiences.EXPERIENCE_ID.ASYNC_OPERATION, {
+    action: _analytics.ACTION.SYNCED_BLOCK_CREATE,
+    dispatchAnalyticsEvent: createExperienceDispatcher(fireAnalyticsEvent),
+    checks: [new _experiences.ExperienceCheckTimeout({
+      durationMs: TIMEOUT_DURATION
+    })]
+  });
+};

package/dist/cjs/utils/resolveSyncBlockInstance.js

@@ -41,7 +41,7 @@ var resolveSyncBlockInstance = exports.resolveSyncBlockInstance = function resol
       sourceTitle: ((_newResult$data2 = newResult.data) === null || _newResult$data2 === void 0 ? void 0 : _newResult$data2.sourceTitle) || ((_oldResult$data2 = oldResult.data) === null || _oldResult$data2 === void 0 ? void 0 : _oldResult$data2.sourceTitle) || undefined
     }, (0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding') && {
       sourceSubType: ((_newResult$data3 = newResult.data) === null || _newResult$data3 === void 0 ? void 0 : _newResult$data3.sourceSubType) || ((_oldResult$data3 = oldResult.data) === null || _oldResult$data3 === void 0 ? void 0 : _oldResult$data3.sourceSubType) || undefined,
-      onSamePage: ((_newResult$data4 = newResult.data) === null || _newResult$data4 === void 0 ? void 0 : _newResult$data4.onSamePage) || ((_oldResult$data4 = oldResult.data) === null || _oldResult$data4 === void 0 ? void 0 : _oldResult$data4.onSamePage) || undefined
+      onSameDocument: ((_newResult$data4 = newResult.data) === null || _newResult$data4 === void 0 ? void 0 : _newResult$data4.onSameDocument) || ((_oldResult$data4 = oldResult.data) === null || _oldResult$data4 === void 0 ? void 0 : _oldResult$data4.onSameDocument) || undefined
     })
   });
 };

package/dist/es2019/clients/block-service/blockSubscription.js

@@ -0,0 +1,125 @@
+import { createClient } from 'graphql-ws';
+const GRAPHQL_WS_ENDPOINT = '/gateway/api/graphql/subscriptions';
+let blockServiceClient = null;
+const getBlockServiceClient = () => {
+  // Don't create client during SSR
+  if (typeof window === 'undefined') {
+    return null;
+  }
+  if (!blockServiceClient) {
+    const protocol = window.location.protocol === 'https:' ? 'wss:' : 'ws:';
+    const wsUrl = `${protocol}//${window.location.host}${GRAPHQL_WS_ENDPOINT}`;
+    blockServiceClient = createClient({
+      url: wsUrl,
+      lazy: true,
+      retryAttempts: 3
+    });
+  }
+  return blockServiceClient;
+};
+const SUBSCRIPTION_QUERY = `
+subscription EDITOR_SYNCED_BLOCK_ON_BLOCK_UPDATED($resourceId: ID!) {
+	blockService_onBlockUpdated(resourceId: $resourceId) {
+		blockAri
+		blockInstanceId
+		content
+		contentUpdatedAt
+		createdAt
+		createdBy
+		deletionReason
+		product
+		sourceAri
+		status
+	}
+}
+`;
+/**
+ * Extracts the resourceId from a block ARI.
+ * Block ARI format: ari:cloud:blocks:<cloudId>:synced-block/<resourceId>
+ * @param blockAri - The block ARI string
+ * @returns The resourceId portion of the ARI
+ */
+const extractResourceIdFromBlockAri = blockAri => {
+  // eslint-disable-next-line require-unicode-regexp
+  const match = blockAri.match(/ari:cloud:blocks:[^:]+:synced-block\/(.+)$/);
+  return (match === null || match === void 0 ? void 0 : match[1]) || null;
+};
+
+/**
+ * Parses the subscription payload into a standardized format.
+ * @param payload - The raw subscription payload
+ * @returns Parsed block data or null if parsing fails
+ */
+const parseSubscriptionPayload = payload => {
+  try {
+    const resourceId = extractResourceIdFromBlockAri(payload.blockAri);
+    if (!resourceId) {
+      return null;
+    }
+    let createdAt;
+    if (payload.createdAt !== undefined && payload.createdAt !== null) {
+      try {
+        // BE returns microseconds, convert to milliseconds
+        createdAt = new Date(payload.createdAt / 1000).toISOString();
+      } catch {
+        createdAt = undefined;
+      }
+    }
+    return {
+      blockAri: payload.blockAri,
+      blockInstanceId: payload.blockInstanceId,
+      content: JSON.parse(payload.content),
+      createdAt,
+      createdBy: payload.createdBy,
+      product: payload.product,
+      resourceId,
+      sourceAri: payload.sourceAri,
+      status: payload.status
+    };
+  } catch {
+    return null;
+  }
+};
+
+/**
+ * Creates a GraphQL subscription to block updates using the shared graphql-ws client.
+ *
+ * @param blockAri - The full block ARI to subscribe to (ari:cloud:blocks:{cloudId}:synced-block/{resourceId})
+ * @param onData - Callback function invoked when block data is updated
+ * @param onError - Optional callback function invoked on subscription errors
+ * @returns Unsubscribe function to close the subscription
+ */
+export const subscribeToBlockUpdates = (blockAri, onData, onError) => {
+  const client = getBlockServiceClient();
+  if (!client) {
+    // Return a no-op unsubscribe if client is not available (e.g., SSR)
+    return () => {};
+  }
+  const unsubscribe = client.subscribe({
+    query: SUBSCRIPTION_QUERY,
+    variables: {
+      resourceId: blockAri
+    },
+    operationName: 'EDITOR_SYNCED_BLOCK_ON_BLOCK_UPDATED'
+  }, {
+    next: value => {
+      var _value$data;
+      if ((_value$data = value.data) !== null && _value$data !== void 0 && _value$data.blockService_onBlockUpdated) {
+        const parsed = parseSubscriptionPayload(value.data.blockService_onBlockUpdated);
+        if (parsed !== null) {
+          onData(parsed);
+        } else {
+          onError === null || onError === void 0 ? void 0 : onError(new Error('Failed to parse block subscription payload'));
+        }
+      }
+    },
+    error: error => {
+      const errorMessage = error instanceof Error ? error.message : 'GraphQL subscription error';
+      onError === null || onError === void 0 ? void 0 : onError(new Error(errorMessage));
+    },
+    complete: () => {
+      // Subscription completed
+    }
+  });
+  return unsubscribe;
+};

package/dist/es2019/clients/jira/sourceInfo.js

@@ -0,0 +1,87 @@
+/* eslint-disable require-unicode-regexp  */
+
+import { fetchWithRetry } from '../../utils/retry';
+const COMMON_HEADERS = {
+  'Content-Type': 'application/json',
+  Accept: 'application/json'
+};
+const AGG_HEADERS = {
+  'X-ExperimentalApi': 'confluence-agg-beta'
+};
+const GRAPHQL_ENDPOINT = '/gateway/api/graphql';
+const GET_SOURCE_INFO_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_GET_SOURCE_INFO';
+/**
+ * Query to get the work item url by id
+ * @param id - the ID of the work item
+ * @returns url of the work item
+ */
+const GET_SOURCE_INFO_QUERY = `query ${GET_SOURCE_INFO_OPERATION_NAME} ($id: ID!) {
+  jira {
+    issueById(id: $id) {
+      id
+      webUrl
+      summary
+    }
+  }}`;
+const getJiraWorkItemSourceInfo = async ari => {
+  const bodyData = {
+    query: GET_SOURCE_INFO_QUERY,
+    operationName: GET_SOURCE_INFO_OPERATION_NAME,
+    variables: {
+      id: ari
+    }
+  };
+  const response = await fetchWithRetry(GRAPHQL_ENDPOINT, {
+    method: 'POST',
+    headers: {
+      ...COMMON_HEADERS,
+      ...AGG_HEADERS
+    },
+    body: JSON.stringify(bodyData)
+  });
+  if (!response.ok) {
+    throw new Error(`Failed to get url: ${response.statusText}`);
+  }
+  return await response.json();
+};
+const resolveNoAccessWorkItemInfo = async ari => {
+  const response = await fetch('/gateway/api/object-resolver/resolve/ari', {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json',
+      Accept: 'application/json'
+    },
+    body: JSON.stringify({
+      ari
+    })
+  });
+  if (response.ok) {
+    var _payload$data, _payload$data2;
+    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;
+    const title = payload === null || payload === void 0 ? void 0 : (_payload$data2 = payload.data) === null || _payload$data2 === void 0 ? void 0 : _payload$data2.name;
+    return {
+      url: typeof url === 'string' ? url : undefined,
+      title: typeof title === 'string' ? title : undefined,
+      sourceAri: ari
+    };
+  } else {
+    throw new Error(`Failed to resolve ari: ${response.statusText}`);
+  }
+};
+export const fetchJiraWorkItemInfo = async (workItemAri, hasAccess) => {
+  if (hasAccess) {
+    var _response$data, _response$data$jira;
+    const response = await getJiraWorkItemSourceInfo(workItemAri);
+    const contentData = (_response$data = response.data) === null || _response$data === void 0 ? void 0 : (_response$data$jira = _response$data.jira) === null || _response$data$jira === void 0 ? void 0 : _response$data$jira.issueById;
+    const webUrl = contentData === null || contentData === void 0 ? void 0 : contentData.webUrl;
+    const summary = contentData === null || contentData === void 0 ? void 0 : contentData.summary;
+    return Promise.resolve({
+      url: webUrl,
+      sourceAri: workItemAri,
+      title: summary
+    });
+  } else {
+    return await resolveNoAccessWorkItemInfo(workItemAri);
+  }
+};

package/dist/es2019/providers/block-service/blockServiceAPI.js

@@ -3,6 +3,7 @@ import { useMemo } from 'react';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { generateBlockAri, generateBlockAriFromReference } from '../../clients/block-service/ari';
 import { batchRetrieveSyncedBlocks, BlockError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getReferenceSyncedBlocksByBlockAri, getSyncedBlockContent, updateReferenceSyncedBlockOnDocument, updateSyncedBlock } from '../../clients/block-service/blockService';
+import { subscribeToBlockUpdates as subscribeToBlockUpdatesWS } from '../../clients/block-service/blockSubscription';
 import { SyncBlockError } from '../../common/types';
 import { stringifyError } from '../../utils/errorHandling';
 import { createResourceIdForReference } from '../../utils/resourceId';
@@ -100,7 +101,8 @@ export const convertToSyncBlockData = (data, resourceId) => {
     createdBy: data.createdBy,
     product: data.product,
     resourceId,
-    sourceAri: data.sourceAri
+    sourceAri: data.sourceAri,
+    status: data.status
   };
 };
 export const fetchReferences = async documentAri => {
@@ -186,7 +188,8 @@ class BlockServiceADFFetchProvider {
           blockInstanceId: blockContentResponse.blockInstanceId,
           // this was the node's localId, but has become the resourceId.
           sourceAri: blockContentResponse.sourceAri,
-          product: blockContentResponse.product
+          product: blockContentResponse.product,
+          status: blockContentResponse.status
         },
         resourceId
       };
@@ -217,7 +220,7 @@ class BlockServiceADFFetchProvider {
         references.push({
           ...reference,
           hasAccess: true,
-          onSamePage: this.parentAri === reference.documentAri
+          onSameDocument: this.parentAri === reference.documentAri
         });
       });
       response.errors.forEach(reference => {
@@ -226,7 +229,7 @@ class BlockServiceADFFetchProvider {
             blockAri: reference.blockAri,
             documentAri: reference.documentAri,
             hasAccess: false,
-            onSamePage: false
+            onSameDocument: false
           });
         }
       });
@@ -311,7 +314,8 @@ class BlockServiceADFFetchProvider {
                 resourceId: blockContentResponse.blockAri,
                 blockInstanceId: blockContentResponse.blockInstanceId,
                 sourceAri: blockContentResponse.sourceAri,
-                product: blockContentResponse.product
+                product: blockContentResponse.product,
+                status: blockContentResponse.status
               },
               resourceId
             });
@@ -358,6 +362,37 @@ class BlockServiceADFFetchProvider {
       }));
     }
   }
+
+  /**
+   * Subscribes to real-time updates for a specific block using GraphQL WebSocket subscriptions.
+   * @param resourceId - The resource ID of the block to subscribe to
+   * @param onUpdate - Callback function invoked when the block is updated
+   * @param onError - Optional callback function invoked on subscription errors
+   * @returns Unsubscribe function to stop receiving updates
+   */
+  subscribeToBlockUpdates(resourceId, onUpdate, onError) {
+    const blockAri = generateBlockAriFromReference({
+      cloudId: this.cloudId,
+      resourceId
+    });
+    return subscribeToBlockUpdatesWS(blockAri, parsedData => {
+      // Convert ParsedBlockSubscriptionData to SyncBlockInstance
+      const syncBlockInstance = {
+        data: {
+          content: parsedData.content,
+          resourceId: parsedData.blockAri,
+          blockInstanceId: parsedData.blockInstanceId,
+          sourceAri: parsedData.sourceAri,
+          product: parsedData.product,
+          createdAt: parsedData.createdAt,
+          createdBy: parsedData.createdBy,
+          status: parsedData.status
+        },
+        resourceId: parsedData.resourceId
+      };
+      onUpdate(syncBlockInstance);
+    }, onError);
+  }
 }
 /**
  * ADFWriteProvider implementation that writes synced block data to Block Service API

package/dist/es2019/providers/syncBlockProvider.js

@@ -4,6 +4,7 @@ import { fg } from '@atlaskit/platform-feature-flags';
 import { getProductFromSourceAri } from '../clients/block-service/ari';
 import { getPageIdAndTypeFromConfluencePageAri } from '../clients/confluence/ari';
 import { fetchConfluencePageInfo } from '../clients/confluence/sourceInfo';
+import { fetchJiraWorkItemInfo } from '../clients/jira/sourceInfo';
 import { SyncBlockError } from '../common/types';
 import { SyncBlockDataProvider } from './types';
 export class SyncBlockProvider extends SyncBlockDataProvider {
@@ -204,7 +205,7 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
             }
             return {
               ...sourceInfo,
-              onSamePage: ((_this$writeProvider3 = this.writeProvider) === null || _this$writeProvider3 === void 0 ? void 0 : _this$writeProvider3.parentAri) === ari,
+              onSameDocument: ((_this$writeProvider3 = this.writeProvider) === null || _this$writeProvider3 === void 0 ? void 0 : _this$writeProvider3.parentAri) === ari,
               productType: product
             };
           } else {
@@ -213,7 +214,16 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
         }
       case 'jira-work-item':
         if (fg('platform_synced_block_dogfooding')) {
-          return Promise.resolve(undefined);
+          var _this$writeProvider4;
+          const sourceInfo = await fetchJiraWorkItemInfo(ari, hasAccess);
+          if (!sourceInfo) {
+            return Promise.resolve(undefined);
+          }
+          return {
+            ...sourceInfo,
+            onSameDocument: ((_this$writeProvider4 = this.writeProvider) === null || _this$writeProvider4 === void 0 ? void 0 : _this$writeProvider4.parentAri) === ari,
+            productType: product
+          };
         }
         return Promise.reject(new Error('Jira work item source product not supported'));
       default:
@@ -282,6 +292,20 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
     }
     return this.fetchProvider.fetchReferences(isSource ? this.generateResourceIdForReference(resourceId) : resourceId);
   }
+
+  /**
+   * Subscribes to real-time updates for a specific block.
+   * @param resourceId - The resource ID of the block to subscribe to
+   * @param onUpdate - Callback function invoked when the block is updated
+   * @param onError - Optional callback function invoked on subscription errors
+   * @returns Unsubscribe function to stop receiving updates, or undefined if not supported
+   */
+  subscribeToBlockUpdates(resourceId, onUpdate, onError) {
+    if (this.fetchProvider.subscribeToBlockUpdates) {
+      return this.fetchProvider.subscribeToBlockUpdates(resourceId, onUpdate, onError);
+    }
+    return undefined;
+  }
 }
 const createSyncedBlockProvider = ({
   fetchProvider,