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

package/dist/esm/utils/relaySubscriptionUtils.js

@@ -1,123 +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) {
-  var relayEnvironment = config.relayEnvironment,
-    cloudId = config.cloudId,
-    resourceId = config.resourceId,
-    onUpdate = config.onUpdate,
-    _onError = config.onError;
-
-  // Convert resourceId to blockAri for the subscription
-  var blockAri = generateBlockAriFromReference({
-    cloudId: cloudId,
-    resourceId: resourceId
-  });
-  var subscriptionQuery = relaySubscriptionUtilsSubscriptionDocument;
-
-  // Try to use Relay subscription first
-  try {
-    var disposable = requestSubscription(relayEnvironment, {
-      subscription: subscriptionQuery,
-      variables: {
-        resourceId: blockAri
-      },
-      onNext: function onNext(response) {
-        if (response !== null && response !== void 0 && response.blockService_onBlockUpdated) {
-          var syncBlockInstance = convertRelayResponseToSyncBlockInstance(response.blockService_onBlockUpdated, resourceId);
-          if (syncBlockInstance) {
-            onUpdate(syncBlockInstance);
-          } else {
-            _onError === null || _onError === void 0 || _onError(new Error('Failed to parse Relay block subscription payload'));
-          }
-        }
-      },
-      onError: function onError(error) {
-        _onError === null || _onError === void 0 || _onError(error);
-      }
-    });
-
-    // If subscription was successfully created, return the unsubscribe function
-    if (disposable) {
-      return function () {
-        disposable.dispose();
-      };
-    }
-  } catch (error) {
-    // If requestSubscription throws, fall back to WebSocket
-    _onError === null || _onError === 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, function (parsedData) {
-    var syncBlockInstance = convertParsedDataToSyncBlockInstance(parsedData, parsedData.resourceId);
-    onUpdate(syncBlockInstance);
-  }, function (error) {
-    _onError === null || _onError === 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 function (resourceId, onUpdate, onError) {
-    var environment = relayEnvironment;
-    if (!environment) {
-      onError === null || onError === void 0 || onError(new Error('Relay environment not available'));
-      return function () {};
-    }
-    return createRelayBlockSubscription({
-      relayEnvironment: environment,
-      cloudId: cloudId,
-      resourceId: resourceId,
-      onUpdate: onUpdate,
-      onError: onError
-    });
-  };
-}

package/dist/types/clients/block-service/sharedSubscriptionUtils.d.ts

@@ -1,61 +0,0 @@
-import type { ADFEntity } from '@atlaskit/adf-utils/types';
-import type { SyncBlockProduct } from '../../common/types';
-/**
- * Shared GraphQL subscription query for block updates.
- * This is the canonical subscription query used across all implementations.
- */
-export declare const 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.
- */
-export type BlockSubscriptionPayload = {
-    blockAri: string;
-    blockInstanceId: string;
-    content: string;
-    contentUpdatedAt?: number;
-    createdAt: number;
-    createdBy: string;
-    deletionReason?: string;
-    product: string;
-    sourceAri: string;
-    status: string;
-};
-/**
- * Parsed and normalized block subscription data.
- * This is the standardized format used across different subscription implementations.
- */
-export type ParsedBlockSubscriptionData = {
-    blockAri: string;
-    blockInstanceId: string;
-    content: ADFEntity[];
-    contentUpdatedAt?: string;
-    createdAt?: string;
-    createdBy: string;
-    product: SyncBlockProduct;
-    resourceId: string;
-    sourceAri: string;
-    status: string;
-};
-/**
- * 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 declare const extractResourceIdFromBlockAri: (blockAri: string) => string | null;
-/**
- * Converts a timestamp to ISO string.
- * @param timestamp - Timestamp in milliseconds
- * @returns ISO string or undefined if conversion fails
- */
-export declare const convertTimestampToISOString: (timestamp?: number) => string | 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 declare const parseSubscriptionPayload: (payload: BlockSubscriptionPayload) => ParsedBlockSubscriptionData | null;

package/dist/types/utils/__generated__/relaySubscriptionUtilsSubscription.graphql.d.ts

@@ -1,31 +0,0 @@
-/**
- * @generated SignedSource<<559b4fb25d0e5bc72be383427a939e2d>>
- * @relayHash 38684212c43376e58fea2d6095011652
- * @lightSyntaxTransform
- * @nogrep
- * @codegen-command: yarn relay
- */
-import type { ConcreteRequest } from 'relay-runtime';
-export type relaySubscriptionUtilsSubscription$variables = {
-    resourceId: string;
-};
-export type relaySubscriptionUtilsSubscription$data = {
-    readonly blockService_onBlockUpdated: {
-        readonly blockAri: string;
-        readonly blockInstanceId: string;
-        readonly content: string;
-        readonly contentUpdatedAt: number | null | undefined;
-        readonly createdAt: number;
-        readonly createdBy: string;
-        readonly deletionReason: string | null | undefined;
-        readonly product: string;
-        readonly sourceAri: string;
-        readonly status: string;
-    } | null | undefined;
-};
-export type relaySubscriptionUtilsSubscription = {
-    response: relaySubscriptionUtilsSubscription$data;
-    variables: relaySubscriptionUtilsSubscription$variables;
-};
-declare const node: ConcreteRequest;
-export default node;

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

@@ -1,47 +0,0 @@
-import { type ParsedBlockSubscriptionData } from '../clients/block-service/sharedSubscriptionUtils';
-import type { ResourceId } from '../common/types';
-import type { SyncBlockInstance } from '../providers/types';
-export type RelayBlockUpdateResponse = {
-    blockAri: string;
-    blockInstanceId: string;
-    content: string;
-    contentUpdatedAt?: number | null;
-    createdAt: number;
-    createdBy: string;
-    deletionReason?: string | null;
-    product: string;
-    sourceAri: string;
-    status: string;
-};
-/**
- * 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 declare function convertParsedDataToSyncBlockInstance(parsed: ParsedBlockSubscriptionData, resourceId: ResourceId): SyncBlockInstance;
-/**
- * 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 declare function convertRelayResponseToSyncBlockInstance(response: RelayBlockUpdateResponse, resourceId: ResourceId): SyncBlockInstance | null;

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

@@ -1,61 +0,0 @@
-import type { IEnvironment } from 'relay-runtime';
-import type { ResourceId } from '../common/types';
-import type { BlockSubscriptionErrorCallback, BlockUpdateCallback, Unsubscribe } from '../providers/types';
-/**
- * Configuration for creating a Relay block subscription.
- */
-export interface RelayBlockSubscriptionConfig {
-    /** Cloud ID for generating block ARIs */
-    cloudId: string;
-    /** Optional callback when subscription errors occur */
-    onError?: BlockSubscriptionErrorCallback;
-    /** Callback when block updates are received */
-    onUpdate: BlockUpdateCallback;
-    /** Relay environment to use for the subscription */
-    relayEnvironment: IEnvironment;
-    /** The resource ID to subscribe to */
-    resourceId: ResourceId;
-}
-/**
- * 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 declare function createRelayBlockSubscription(config: RelayBlockSubscriptionConfig): Unsubscribe;
-/**
- * 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 declare function createRelaySubscriptionFunction(cloudId: string, relayEnvironment?: IEnvironment): (resourceId: ResourceId, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback) => Unsubscribe;

package/dist/types-ts4.5/clients/block-service/sharedSubscriptionUtils.d.ts

@@ -1,61 +0,0 @@
-import type { ADFEntity } from '@atlaskit/adf-utils/types';
-import type { SyncBlockProduct } from '../../common/types';
-/**
- * Shared GraphQL subscription query for block updates.
- * This is the canonical subscription query used across all implementations.
- */
-export declare const 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.
- */
-export type BlockSubscriptionPayload = {
-    blockAri: string;
-    blockInstanceId: string;
-    content: string;
-    contentUpdatedAt?: number;
-    createdAt: number;
-    createdBy: string;
-    deletionReason?: string;
-    product: string;
-    sourceAri: string;
-    status: string;
-};
-/**
- * Parsed and normalized block subscription data.
- * This is the standardized format used across different subscription implementations.
- */
-export type ParsedBlockSubscriptionData = {
-    blockAri: string;
-    blockInstanceId: string;
-    content: ADFEntity[];
-    contentUpdatedAt?: string;
-    createdAt?: string;
-    createdBy: string;
-    product: SyncBlockProduct;
-    resourceId: string;
-    sourceAri: string;
-    status: string;
-};
-/**
- * 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 declare const extractResourceIdFromBlockAri: (blockAri: string) => string | null;
-/**
- * Converts a timestamp to ISO string.
- * @param timestamp - Timestamp in milliseconds
- * @returns ISO string or undefined if conversion fails
- */
-export declare const convertTimestampToISOString: (timestamp?: number) => string | 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 declare const parseSubscriptionPayload: (payload: BlockSubscriptionPayload) => ParsedBlockSubscriptionData | null;

package/dist/types-ts4.5/utils/__generated__/relaySubscriptionUtilsSubscription.graphql.d.ts

@@ -1,31 +0,0 @@
-/**
- * @generated SignedSource<<559b4fb25d0e5bc72be383427a939e2d>>
- * @relayHash 38684212c43376e58fea2d6095011652
- * @lightSyntaxTransform
- * @nogrep
- * @codegen-command: yarn relay
- */
-import type { ConcreteRequest } from 'relay-runtime';
-export type relaySubscriptionUtilsSubscription$variables = {
-    resourceId: string;
-};
-export type relaySubscriptionUtilsSubscription$data = {
-    readonly blockService_onBlockUpdated: {
-        readonly blockAri: string;
-        readonly blockInstanceId: string;
-        readonly content: string;
-        readonly contentUpdatedAt: number | null | undefined;
-        readonly createdAt: number;
-        readonly createdBy: string;
-        readonly deletionReason: string | null | undefined;
-        readonly product: string;
-        readonly sourceAri: string;
-        readonly status: string;
-    } | null | undefined;
-};
-export type relaySubscriptionUtilsSubscription = {
-    response: relaySubscriptionUtilsSubscription$data;
-    variables: relaySubscriptionUtilsSubscription$variables;
-};
-declare const node: ConcreteRequest;
-export default node;

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

@@ -1,47 +0,0 @@
-import { type ParsedBlockSubscriptionData } from '../clients/block-service/sharedSubscriptionUtils';
-import type { ResourceId } from '../common/types';
-import type { SyncBlockInstance } from '../providers/types';
-export type RelayBlockUpdateResponse = {
-    blockAri: string;
-    blockInstanceId: string;
-    content: string;
-    contentUpdatedAt?: number | null;
-    createdAt: number;
-    createdBy: string;
-    deletionReason?: string | null;
-    product: string;
-    sourceAri: string;
-    status: string;
-};
-/**
- * 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 declare function convertParsedDataToSyncBlockInstance(parsed: ParsedBlockSubscriptionData, resourceId: ResourceId): SyncBlockInstance;
-/**
- * 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 declare function convertRelayResponseToSyncBlockInstance(response: RelayBlockUpdateResponse, resourceId: ResourceId): SyncBlockInstance | null;

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

@@ -1,61 +0,0 @@
-import type { IEnvironment } from 'relay-runtime';
-import type { ResourceId } from '../common/types';
-import type { BlockSubscriptionErrorCallback, BlockUpdateCallback, Unsubscribe } from '../providers/types';
-/**
- * Configuration for creating a Relay block subscription.
- */
-export interface RelayBlockSubscriptionConfig {
-    /** Cloud ID for generating block ARIs */
-    cloudId: string;
-    /** Optional callback when subscription errors occur */
-    onError?: BlockSubscriptionErrorCallback;
-    /** Callback when block updates are received */
-    onUpdate: BlockUpdateCallback;
-    /** Relay environment to use for the subscription */
-    relayEnvironment: IEnvironment;
-    /** The resource ID to subscribe to */
-    resourceId: ResourceId;
-}
-/**
- * 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 declare function createRelayBlockSubscription(config: RelayBlockSubscriptionConfig): Unsubscribe;
-/**
- * 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 declare function createRelaySubscriptionFunction(cloudId: string, relayEnvironment?: IEnvironment): (resourceId: ResourceId, onUpdate: BlockUpdateCallback, onError?: BlockSubscriptionErrorCallback) => Unsubscribe;