@atlaskit/editor-synced-block-provider 3.30.6 → 3.31.1

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

@@ -1,91 +0,0 @@
-import { convertContentUpdatedAt } from '../../utils/utils';
-/**
- * Shared GraphQL subscription query for block updates.
- * This is the canonical subscription query used across all implementations.
- */
-export const BLOCK_SERVICE_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
-	}
-}
-`;
-
-/**
- * Raw subscription payload from the GraphQL subscription.
- * This represents the exact shape returned by the blockService_onBlockUpdated subscription.
- */
-
-/**
- * Parsed and normalized block subscription data.
- * This is the standardized format used across different subscription implementations.
- */
-
-/**
- * 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
- */
-export 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;
-};
-
-/**
- * Converts a timestamp to ISO string.
- * @param timestamp - Timestamp in milliseconds
- * @returns ISO string or undefined if conversion fails
- */
-export const convertTimestampToISOString = timestamp => {
-  if (timestamp === undefined || timestamp === null) {
-    return undefined;
-  }
-  try {
-    return new Date(timestamp).toISOString();
-  } catch {
-    return undefined;
-  }
-};
-
-/**
- * Parses the raw subscription payload into a standardized format.
- * This function handles all the data transformation and error handling consistently
- * across different subscription implementations.
- * 
- * @param payload - The raw subscription payload
- * @returns Parsed block data or null if parsing fails
- */
-export const parseSubscriptionPayload = payload => {
-  try {
-    const resourceId = extractResourceIdFromBlockAri(payload.blockAri);
-    if (!resourceId) {
-      return null;
-    }
-    const createdAt = convertTimestampToISOString(payload.createdAt);
-    return {
-      blockAri: payload.blockAri,
-      blockInstanceId: payload.blockInstanceId,
-      content: JSON.parse(payload.content),
-      contentUpdatedAt: convertContentUpdatedAt(payload.contentUpdatedAt),
-      createdAt,
-      createdBy: payload.createdBy,
-      product: payload.product,
-      resourceId,
-      sourceAri: payload.sourceAri,
-      status: payload.status
-    };
-  } catch {
-    return null;
-  }
-};

package/dist/es2019/utils/__generated__/relaySubscriptionUtilsSubscription.graphql.js

@@ -1,88 +0,0 @@
-/**
- * @generated SignedSource<<559b4fb25d0e5bc72be383427a939e2d>>
- * @relayHash 38684212c43376e58fea2d6095011652
- * @lightSyntaxTransform
- * @nogrep
- * @codegen-command: yarn relay
- */
-
-/* tslint:disable */
-/* eslint-disable */
-// @ts-nocheck
-
-// @relayRequestID c84045a1f05bd1e73ade0a9d8b18462cc3dad5dcae1ebabab76b13135411c530
-
-const node = function () {
-  var v0 = [{
-      "defaultValue": null,
-      "kind": "LocalArgument",
-      "name": "resourceId"
-    }],
-    v1 = [{
-      "args": [{
-        "kind": "Variable",
-        "name": "resourceId",
-        "variableName": "resourceId"
-      }],
-      "concreteType": "BlockServiceBlockPayload",
-      "kind": "LinkedField",
-      "name": "blockService_onBlockUpdated",
-      "plural": false,
-      "selections": [{
-        "kind": "ScalarField",
-        "name": "blockAri"
-      }, {
-        "kind": "ScalarField",
-        "name": "blockInstanceId"
-      }, {
-        "kind": "ScalarField",
-        "name": "content"
-      }, {
-        "kind": "ScalarField",
-        "name": "contentUpdatedAt"
-      }, {
-        "kind": "ScalarField",
-        "name": "createdAt"
-      }, {
-        "kind": "ScalarField",
-        "name": "createdBy"
-      }, {
-        "kind": "ScalarField",
-        "name": "deletionReason"
-      }, {
-        "kind": "ScalarField",
-        "name": "product"
-      }, {
-        "kind": "ScalarField",
-        "name": "sourceAri"
-      }, {
-        "kind": "ScalarField",
-        "name": "status"
-      }]
-    }];
-  return {
-    "fragment": {
-      "argumentDefinitions": v0 /*: any*/,
-      "kind": "Fragment",
-      "name": "relaySubscriptionUtilsSubscription",
-      "selections": v1 /*: any*/,
-      "type": "Subscription"
-    },
-    "kind": "Request",
-    "operation": {
-      "argumentDefinitions": v0 /*: any*/,
-      "kind": "Operation",
-      "name": "relaySubscriptionUtilsSubscription",
-      "selections": v1 /*: any*/
-    },
-    "params": {
-      "id": "c84045a1f05bd1e73ade0a9d8b18462cc3dad5dcae1ebabab76b13135411c530",
-      "metadata": {},
-      "name": "relaySubscriptionUtilsSubscription",
-      "operationKind": "subscription",
-      "text": null
-    }
-  };
-}();
-node.hash = "6f3ebc87921555436cad753ec1aead2e";
-export default node;

package/dist/es2019/utils/relayResponseConverter.js

@@ -1,69 +0,0 @@
-import { parseSubscriptionPayload } from '../clients/block-service/sharedSubscriptionUtils';
-import { normaliseSyncBlockStatus } from './validValue';
-/**
- * Converts parsed subscription data to SyncBlockInstance format.
- *
- * @param parsed - The parsed subscription data
- * @param resourceId - The resource ID for the block
- * @returns A SyncBlockInstance
- */
-export function convertParsedDataToSyncBlockInstance(parsed, resourceId) {
-  return {
-    data: {
-      content: parsed.content,
-      contentUpdatedAt: parsed.contentUpdatedAt,
-      resourceId: parsed.blockAri,
-      blockInstanceId: parsed.blockInstanceId,
-      sourceAri: parsed.sourceAri,
-      product: parsed.product,
-      createdAt: parsed.createdAt,
-      createdBy: parsed.createdBy,
-      status: normaliseSyncBlockStatus(parsed.status)
-    },
-    resourceId
-  };
-}
-
-/**
- * Converts a Relay subscription response to SyncBlockInstance format using shared parsing logic.
-
- * @param response - The Relay subscription response containing block update data
- * @param resourceId - The resource ID for the block
- * @returns A SyncBlockInstance or null if parsing fails
- * 
- * @example
- * ```typescript
- * // In a Relay subscription handler
- * onNext: (response) => {
- *   if (response?.blockService_onBlockUpdated) {
- *     const syncBlockInstance = convertRelayResponseToSyncBlockInstance(
- *       response.blockService_onBlockUpdated,
- *       resourceId,
- *     );
- *     if (syncBlockInstance) {
- *       onUpdate(syncBlockInstance);
- *     }
- *   }
- * }
- * ```
- */
-export function convertRelayResponseToSyncBlockInstance(response, resourceId) {
-  var _response$contentUpda, _response$deletionRea;
-  const payload = {
-    blockAri: response.blockAri,
-    blockInstanceId: response.blockInstanceId,
-    content: response.content,
-    contentUpdatedAt: (_response$contentUpda = response.contentUpdatedAt) !== null && _response$contentUpda !== void 0 ? _response$contentUpda : undefined,
-    createdAt: response.createdAt,
-    createdBy: response.createdBy,
-    deletionReason: (_response$deletionRea = response.deletionReason) !== null && _response$deletionRea !== void 0 ? _response$deletionRea : undefined,
-    product: response.product,
-    sourceAri: response.sourceAri,
-    status: response.status
-  };
-  const parsed = parseSubscriptionPayload(payload);
-  if (!parsed) {
-    return null;
-  }
-  return convertParsedDataToSyncBlockInstance(parsed, resourceId);
-}

package/dist/es2019/utils/relaySubscriptionUtils.js

@@ -1,125 +0,0 @@
-import { requestSubscription } from 'relay-runtime';
-import { generateBlockAriFromReference } from '../clients/block-service/ari';
-import { subscribeToBlockUpdates as subscribeToBlockUpdatesWS } from '../clients/block-service/blockSubscription';
-import relaySubscriptionUtilsSubscriptionDocument from './__generated__/relaySubscriptionUtilsSubscription.graphql';
-import { convertRelayResponseToSyncBlockInstance, convertParsedDataToSyncBlockInstance } from './relayResponseConverter';
-
-/**
- * Configuration for creating a Relay block subscription.
- */
-
-/**
- * Creates a Relay-based block subscription without needing to wrap providers.
- * This is a clean utility function that can be used directly in components or hooks.
- * 
- * @param config - Configuration for the subscription
- * @returns An unsubscribe function to dispose the subscription
- * 
- * @example
- * ```typescript
- * const unsubscribe = createRelayBlockSubscription({
- *   relayEnvironment: environment,
- *   cloudId: 'my-cloud-id',
- *   resourceId: 'my-resource-id',
- *   onUpdate: (blockInstance) => {
- *     console.log('Block updated:', blockInstance);
- *   },
- *   onError: (error) => {
- *     console.error('Subscription error:', error);
- *   }
- * });
- * 
- * // Later, when component unmounts or subscription is no longer needed
- * unsubscribe();
- * ```
- */
-export function createRelayBlockSubscription(config) {
-  const {
-    relayEnvironment,
-    cloudId,
-    resourceId,
-    onUpdate,
-    onError
-  } = config;
-
-  // Convert resourceId to blockAri for the subscription
-  const blockAri = generateBlockAriFromReference({
-    cloudId,
-    resourceId
-  });
-  const subscriptionQuery = relaySubscriptionUtilsSubscriptionDocument;
-
-  // Try to use Relay subscription first
-  try {
-    const disposable = requestSubscription(relayEnvironment, {
-      subscription: subscriptionQuery,
-      variables: {
-        resourceId: blockAri
-      },
-      onNext: response => {
-        if (response !== null && response !== void 0 && response.blockService_onBlockUpdated) {
-          const syncBlockInstance = convertRelayResponseToSyncBlockInstance(response.blockService_onBlockUpdated, resourceId);
-          if (syncBlockInstance) {
-            onUpdate(syncBlockInstance);
-          } else {
-            onError === null || onError === void 0 ? void 0 : onError(new Error('Failed to parse Relay block subscription payload'));
-          }
-        }
-      },
-      onError: error => {
-        onError === null || onError === void 0 ? void 0 : onError(error);
-      }
-    });
-
-    // If subscription was successfully created, return the unsubscribe function
-    if (disposable) {
-      return () => {
-        disposable.dispose();
-      };
-    }
-  } catch (error) {
-    // If requestSubscription throws, fall back to WebSocket
-    onError === null || onError === void 0 ? void 0 : onError(error instanceof Error ? error : new Error('Relay subscription failed'));
-  }
-
-  // Fallback to WebSocket subscription when Relay subscriptions aren't available
-  return subscribeToBlockUpdatesWS(blockAri, parsedData => {
-    const syncBlockInstance = convertParsedDataToSyncBlockInstance(parsedData, parsedData.resourceId);
-    onUpdate(syncBlockInstance);
-  }, error => {
-    onError === null || onError === void 0 ? void 0 : onError(error);
-  });
-}
-
-/**
- * Hook-like function to create a subscription function that can be passed to providers.
- * This creates a function with the same signature as subscribeToBlockUpdates that uses Relay.
- * 
- * @param cloudId - Cloud ID for generating block ARIs  
- * @param relayEnvironment - Optional Relay environment. If not provided, will attempt to use global environment
- * @returns A function that can be used as subscribeToBlockUpdates in provider configurations
- * 
- * @example
- * ```typescript
- * const relaySubscribeToBlockUpdates = createRelaySubscriptionFunction(cloudId, environment);
- * 
- * // Can be used directly as a subscribeToBlockUpdates replacement
- * const unsubscribe = relaySubscribeToBlockUpdates(resourceId, onUpdate, onError);
- * ```
- */
-export function createRelaySubscriptionFunction(cloudId, relayEnvironment) {
-  return (resourceId, onUpdate, onError) => {
-    const environment = relayEnvironment;
-    if (!environment) {
-      onError === null || onError === void 0 ? void 0 : onError(new Error('Relay environment not available'));
-      return () => {};
-    }
-    return createRelayBlockSubscription({
-      relayEnvironment: environment,
-      cloudId,
-      resourceId,
-      onUpdate,
-      onError
-    });
-  };
-}

package/dist/esm/clients/block-service/sharedSubscriptionUtils.js

@@ -1,76 +0,0 @@
-import { convertContentUpdatedAt } from '../../utils/utils';
-/**
- * Shared GraphQL subscription query for block updates.
- * This is the canonical subscription query used across all implementations.
- */
-export var BLOCK_SERVICE_SUBSCRIPTION_QUERY = "\nsubscription EDITOR_SYNCED_BLOCK_ON_BLOCK_UPDATED($resourceId: ID!) {\n\tblockService_onBlockUpdated(resourceId: $resourceId) {\n\t\tblockAri\n\t\tblockInstanceId\n\t\tcontent\n\t\tcontentUpdatedAt\n\t\tcreatedAt\n\t\tcreatedBy\n\t\tdeletionReason\n\t\tproduct\n\t\tsourceAri\n\t\tstatus\n\t}\n}\n";
-
-/**
- * Raw subscription payload from the GraphQL subscription.
- * This represents the exact shape returned by the blockService_onBlockUpdated subscription.
- */
-
-/**
- * Parsed and normalized block subscription data.
- * This is the standardized format used across different subscription implementations.
- */
-
-/**
- * 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
- */
-export var extractResourceIdFromBlockAri = function extractResourceIdFromBlockAri(blockAri) {
-  // eslint-disable-next-line require-unicode-regexp
-  var match = blockAri.match(/ari:cloud:blocks:[^:]+:synced-block\/(.+)$/);
-  return (match === null || match === void 0 ? void 0 : match[1]) || null;
-};
-
-/**
- * Converts a timestamp to ISO string.
- * @param timestamp - Timestamp in milliseconds
- * @returns ISO string or undefined if conversion fails
- */
-export var convertTimestampToISOString = function convertTimestampToISOString(timestamp) {
-  if (timestamp === undefined || timestamp === null) {
-    return undefined;
-  }
-  try {
-    return new Date(timestamp).toISOString();
-  } catch (_unused) {
-    return undefined;
-  }
-};
-
-/**
- * Parses the raw subscription payload into a standardized format.
- * This function handles all the data transformation and error handling consistently
- * across different subscription implementations.
- * 
- * @param payload - The raw subscription payload
- * @returns Parsed block data or null if parsing fails
- */
-export var parseSubscriptionPayload = function parseSubscriptionPayload(payload) {
-  try {
-    var resourceId = extractResourceIdFromBlockAri(payload.blockAri);
-    if (!resourceId) {
-      return null;
-    }
-    var createdAt = convertTimestampToISOString(payload.createdAt);
-    return {
-      blockAri: payload.blockAri,
-      blockInstanceId: payload.blockInstanceId,
-      content: JSON.parse(payload.content),
-      contentUpdatedAt: convertContentUpdatedAt(payload.contentUpdatedAt),
-      createdAt: createdAt,
-      createdBy: payload.createdBy,
-      product: payload.product,
-      resourceId: resourceId,
-      sourceAri: payload.sourceAri,
-      status: payload.status
-    };
-  } catch (_unused2) {
-    return null;
-  }
-};

package/dist/esm/utils/__generated__/relaySubscriptionUtilsSubscription.graphql.js

@@ -1,88 +0,0 @@
-/**
- * @generated SignedSource<<559b4fb25d0e5bc72be383427a939e2d>>
- * @relayHash 38684212c43376e58fea2d6095011652
- * @lightSyntaxTransform
- * @nogrep
- * @codegen-command: yarn relay
- */
-
-/* tslint:disable */
-/* eslint-disable */
-// @ts-nocheck
-
-// @relayRequestID c84045a1f05bd1e73ade0a9d8b18462cc3dad5dcae1ebabab76b13135411c530
-
-var node = function () {
-  var v0 = [{
-      "defaultValue": null,
-      "kind": "LocalArgument",
-      "name": "resourceId"
-    }],
-    v1 = [{
-      "args": [{
-        "kind": "Variable",
-        "name": "resourceId",
-        "variableName": "resourceId"
-      }],
-      "concreteType": "BlockServiceBlockPayload",
-      "kind": "LinkedField",
-      "name": "blockService_onBlockUpdated",
-      "plural": false,
-      "selections": [{
-        "kind": "ScalarField",
-        "name": "blockAri"
-      }, {
-        "kind": "ScalarField",
-        "name": "blockInstanceId"
-      }, {
-        "kind": "ScalarField",
-        "name": "content"
-      }, {
-        "kind": "ScalarField",
-        "name": "contentUpdatedAt"
-      }, {
-        "kind": "ScalarField",
-        "name": "createdAt"
-      }, {
-        "kind": "ScalarField",
-        "name": "createdBy"
-      }, {
-        "kind": "ScalarField",
-        "name": "deletionReason"
-      }, {
-        "kind": "ScalarField",
-        "name": "product"
-      }, {
-        "kind": "ScalarField",
-        "name": "sourceAri"
-      }, {
-        "kind": "ScalarField",
-        "name": "status"
-      }]
-    }];
-  return {
-    "fragment": {
-      "argumentDefinitions": v0 /*: any*/,
-      "kind": "Fragment",
-      "name": "relaySubscriptionUtilsSubscription",
-      "selections": v1 /*: any*/,
-      "type": "Subscription"
-    },
-    "kind": "Request",
-    "operation": {
-      "argumentDefinitions": v0 /*: any*/,
-      "kind": "Operation",
-      "name": "relaySubscriptionUtilsSubscription",
-      "selections": v1 /*: any*/
-    },
-    "params": {
-      "id": "c84045a1f05bd1e73ade0a9d8b18462cc3dad5dcae1ebabab76b13135411c530",
-      "metadata": {},
-      "name": "relaySubscriptionUtilsSubscription",
-      "operationKind": "subscription",
-      "text": null
-    }
-  };
-}();
-node.hash = "6f3ebc87921555436cad753ec1aead2e";
-export default node;

package/dist/esm/utils/relayResponseConverter.js

@@ -1,69 +0,0 @@
-import { parseSubscriptionPayload } from '../clients/block-service/sharedSubscriptionUtils';
-import { normaliseSyncBlockStatus } from './validValue';
-/**
- * Converts parsed subscription data to SyncBlockInstance format.
- *
- * @param parsed - The parsed subscription data
- * @param resourceId - The resource ID for the block
- * @returns A SyncBlockInstance
- */
-export function convertParsedDataToSyncBlockInstance(parsed, resourceId) {
-  return {
-    data: {
-      content: parsed.content,
-      contentUpdatedAt: parsed.contentUpdatedAt,
-      resourceId: parsed.blockAri,
-      blockInstanceId: parsed.blockInstanceId,
-      sourceAri: parsed.sourceAri,
-      product: parsed.product,
-      createdAt: parsed.createdAt,
-      createdBy: parsed.createdBy,
-      status: normaliseSyncBlockStatus(parsed.status)
-    },
-    resourceId: resourceId
-  };
-}
-
-/**
- * Converts a Relay subscription response to SyncBlockInstance format using shared parsing logic.
-
- * @param response - The Relay subscription response containing block update data
- * @param resourceId - The resource ID for the block
- * @returns A SyncBlockInstance or null if parsing fails
- * 
- * @example
- * ```typescript
- * // In a Relay subscription handler
- * onNext: (response) => {
- *   if (response?.blockService_onBlockUpdated) {
- *     const syncBlockInstance = convertRelayResponseToSyncBlockInstance(
- *       response.blockService_onBlockUpdated,
- *       resourceId,
- *     );
- *     if (syncBlockInstance) {
- *       onUpdate(syncBlockInstance);
- *     }
- *   }
- * }
- * ```
- */
-export function convertRelayResponseToSyncBlockInstance(response, resourceId) {
-  var _response$contentUpda, _response$deletionRea;
-  var payload = {
-    blockAri: response.blockAri,
-    blockInstanceId: response.blockInstanceId,
-    content: response.content,
-    contentUpdatedAt: (_response$contentUpda = response.contentUpdatedAt) !== null && _response$contentUpda !== void 0 ? _response$contentUpda : undefined,
-    createdAt: response.createdAt,
-    createdBy: response.createdBy,
-    deletionReason: (_response$deletionRea = response.deletionReason) !== null && _response$deletionRea !== void 0 ? _response$deletionRea : undefined,
-    product: response.product,
-    sourceAri: response.sourceAri,
-    status: response.status
-  };
-  var parsed = parseSubscriptionPayload(payload);
-  if (!parsed) {
-    return null;
-  }
-  return convertParsedDataToSyncBlockInstance(parsed, resourceId);
-}