@atlaskit/editor-synced-block-provider 7.0.14 → 7.0.15

package/dist/types-ts4.5/store-manager/syncBlockStoreManager.d.ts

@@ -1,24 +0,0 @@
-import type { SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
-import type { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
-import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { BlockInstanceId, ReferencesSourceInfo, ResourceId } from '../common/types';
-import type { SyncBlockDataProviderInterface } from '../providers/types';
-import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
-import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
-export declare class SyncBlockStoreManager {
-    private referenceSyncBlockStoreManager;
-    private sourceSyncBlockStoreManager;
-    private dataProvider?;
-    private fireAnalyticsEvent?;
-    private fetchReferencesExperience;
-    private fetchSourceInfoExperience;
-    constructor(dataProvider?: SyncBlockDataProviderInterface, viewMode?: ViewMode, isLivePage?: boolean);
-    isSyncBlock(node: PMNode): boolean;
-    fetchReferencesSourceInfo(resourceId: ResourceId, blockInstanceId: BlockInstanceId, isSourceSyncBlock: boolean): Promise<ReferencesSourceInfo>;
-    setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
-    get referenceManager(): ReferenceSyncBlockStoreManager;
-    get sourceManager(): SourceSyncBlockStoreManager;
-    destroy(): void;
-    private getUnregisteredReferences;
-}
-export declare const useMemoizedSyncBlockStoreManager: (dataProvider?: SyncBlockDataProviderInterface, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => SyncBlockStoreManager;

package/dist/types-ts4.5/store-manager/syncBlockSubscriptionManager.d.ts

@@ -1,84 +0,0 @@
-import type { RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
-import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { ResourceId, BlockInstanceId } from '../common/types';
-import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProviderInterface, SyncBlockSourceInfo, TitleSubscriptionCallback } from '../providers/types';
-export interface SyncBlockSubscriptionManagerDeps {
-    /** Cancels any pending cache deletion timer for `resourceId` (gated). */
-    cancelPendingCacheDeletion: (resourceId: ResourceId) => void;
-    debouncedBatchedFetchSyncBlocks: (resourceId: string) => void;
-    deleteFromCache: (resourceId: ResourceId) => void;
-    fetchSyncBlockSourceInfo: (resourceId: ResourceId) => Promise<SyncBlockSourceInfo | undefined>;
-    getDataProvider: () => SyncBlockDataProviderInterface | undefined;
-    getFireAnalyticsEvent: () => ((payload: RendererSyncBlockEventPayload) => void) | undefined;
-    getFromCache: (resourceId: ResourceId) => SyncBlockInstance | undefined;
-    markCacheDirty: () => void;
-    /** Schedules guarded cache deletion for `resourceId` after a grace period (gated). */
-    scheduleCacheDeletion: (resourceId: ResourceId) => void;
-    updateCache: (syncBlockInstance: SyncBlockInstance) => void;
-}
-/**
- * Manages the lifecycle of GraphQL WebSocket subscriptions for sync block
- * real-time updates, owns the subscriptions and titleSubscriptions maps,
- * and provides a listener API so React components can react when the set
- * of subscribed resource IDs changes.
- */
-export declare class SyncBlockSubscriptionManager {
-    private deps;
-    private subscriptions;
-    private titleSubscriptions;
-    private graphqlSubscriptions;
-    private subscriptionChangeListeners;
-    private useRealTimeSubscriptions;
-    private pendingCacheDeletions;
-    private static readonly INITIAL_RETRY_DELAY_MS;
-    private static readonly RETRY_BACKOFF_MULTIPLIER;
-    private static readonly MAX_RETRY_ATTEMPTS;
-    private retryAttempts;
-    private pendingRetries;
-    constructor(deps: SyncBlockSubscriptionManagerDeps);
-    /**
-     * Returns the subscriptions map. Used by external consumers (e.g. batch fetcher, flush)
-     * that need to read the current subscription state.
-     */
-    getSubscriptions(): Map<ResourceId, {
-        [localId: BlockInstanceId]: SubscriptionCallback;
-    }>;
-    setRealTimeSubscriptionsEnabled(enabled: boolean): void;
-    isRealTimeSubscriptionsEnabled(): boolean;
-    getSubscribedResourceIds(): ResourceId[];
-    onSubscriptionsChanged(listener: () => void): () => void;
-    notifySubscriptionChangeListeners(): void;
-    handleSubscriptionUpdate(syncBlockInstance: SyncBlockInstance): void;
-    subscribeToSyncBlock(resourceId: string, localId: string, callback: SubscriptionCallback): () => void;
-    subscribeToSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
-    updateSourceTitleSubscriptions(resourceId: string, title: string): void;
-    /**
-     * Notifies all subscription callbacks for a given resource ID with the provided sync block instance.
-     */
-    notifySubscriptionCallbacks(resourceId: ResourceId, syncBlock: SyncBlockInstance): void;
-    setupSubscription(resourceId: ResourceId): void;
-    /**
-     * Handles subscription termination (complete or error) by cleaning up the
-     * stale entry and scheduling a reconnection with exponential backoff.
-     */
-    private handleSubscriptionTerminated;
-    /**
-     * Schedules a reconnection attempt with exponential backoff.
-     * Delay = INITIAL_RETRY_DELAY_MS * (RETRY_BACKOFF_MULTIPLIER ^ attempts)
-     * e.g. 1s, 2s, 4s, 8s, 16s
-     */
-    private scheduleReconnection;
-    /**
-     * Resets the retry counter for a resource. Called when a successful
-     * update is received, indicating the subscription is healthy.
-     */
-    private resetRetryCount;
-    private cancelPendingRetry;
-    private cancelAllPendingRetries;
-    cleanupSubscription(resourceId: ResourceId): void;
-    setupSubscriptionsForAllBlocks(): void;
-    cleanupAll(): void;
-    destroy(): void;
-    shouldUseRealTime(): boolean;
-    private handleGraphQLUpdate;
-}

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

@@ -1,36 +0,0 @@
-import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
-import type { RendererSyncBlockEventPayload, OperationalAEP, SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
-export declare const stringifyError: (error: unknown) => string | undefined;
-export declare const getErrorPayload: <T extends ACTION_SUBJECT_ID>(actionSubjectId: T, error: string, resourceId?: string, sourceProduct?: string) => OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, T, {
-    error: string;
-    resourceId?: string;
-    sourceProduct?: string;
-}>;
-export declare const fetchErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => RendererSyncBlockEventPayload;
-export declare const getSourceInfoErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => RendererSyncBlockEventPayload;
-export declare const updateErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => SyncBlockEventPayload;
-export declare const updateReferenceErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => RendererSyncBlockEventPayload;
-export declare const createErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => SyncBlockEventPayload;
-export declare const deleteErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => SyncBlockEventPayload;
-export declare const updateCacheErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => SyncBlockEventPayload;
-/**
- * Payload for `SYNCED_BLOCK_SOURCE_INFO_ORPHANED`. Fired when source-info
- * resolves into a cache that has already been deleted — should be unreachable
- * under `platform_synced_block_patch_14`.
- */
-export declare const sourceInfoOrphanedPayload: (resourceId?: string, sourceProduct?: string, context?: {
-    hasPendingDeletion?: boolean;
-    hasSubscribers?: boolean;
-}) => RendererSyncBlockEventPayload;
-/**
- * Payload for `SYNCED_BLOCK_CACHE_DELETION_FORCED`. Fired when the cache
- * deletion timer has been rescheduled `MAX_RESCHEDULE_COUNT` times and we force
- * the deletion to avoid leaking memory. Indicates a stuck in-flight flag.
- */
-export declare const cacheDeletionForcedPayload: (rescheduleCount: number, resourceId?: string, sourceProduct?: string) => RendererSyncBlockEventPayload;
-export declare const fetchReferencesErrorPayload: (error: string, resourceId?: string, sourceProduct?: string) => SyncBlockEventPayload;
-export declare const fetchSuccessPayload: (resourceId: string, blockInstanceId?: string, sourceProduct?: string) => RendererSyncBlockEventPayload;
-export declare const createSuccessPayload: (resourceId: string, sourceProduct?: string) => SyncBlockEventPayload;
-export declare const createSuccessPayloadNew: (resourceId: string) => SyncBlockEventPayload;
-export declare const updateSuccessPayload: (resourceId: string, hasReference?: boolean, sourceProduct?: string) => SyncBlockEventPayload;
-export declare const deleteSuccessPayload: (resourceId: string, sourceProduct?: string) => SyncBlockEventPayload;

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

@@ -1,59 +0,0 @@
-import type { DispatchAnalyticsEvent, SyncBlockEventPayload, RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
-import { Experience } from '@atlaskit/editor-common/experiences';
-export declare const createExperienceDispatcher: (fireAnalyticsEvent?: ((payload: SyncBlockEventPayload) => void) | ((payload: RendererSyncBlockEventPayload) => void)) => DispatchAnalyticsEvent;
-/**
- * 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
- */
-export declare const getSaveSourceExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;
-/**
- * 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
- */
-export declare const getSaveReferenceExperience: (fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void) => Experience;
-/**
- * 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
- */
-export declare const getFetchExperience: (fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void) => Experience;
-/**
- * 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
- */
-export declare const getFetchSourceInfoExperience: (fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void) => Experience;
-/**
- * This experience tracks when a source sync block is deleted from the BE.
- *
- * Start: When the delete source sync block function is called.
- * Success: When the sync block deletion is successful within the timeout duration of start.
- * Failure: When the timeout duration passes without the sync block being successfully deleted, or the deletion fails
- */
-export declare const getDeleteSourceExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;
-/**
- * This experience tracks when a source sync block is created and registered to the BE.
- *
- * Start: When the create source sync block function is called.
- * Success: When the sync block creation is successful within the timeout duration of start.
- * Failure: When the timeout duration passes without the sync block being successfully created, or the creation fails
- */
-export declare const getCreateSourceExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;
-/**
- * This experience tracks when references for a sync block are fetched from the BE.
- *
- * Start: When the fetchReferences function is called.
- * Success: When the fetching of references is successful within the timeout duration of start.
- * Failure: When the timeout duration passes without references being successfully fetched, or the fetch fails
- */
-export declare const getFetchReferencesExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;

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

@@ -1,13 +0,0 @@
-import type { SyncBlockInstance } from '../providers/types';
-/**
- * Merges two SyncBlockInstance objects,
- * preserving sourceURL, sourceTitle, sourceSubType, and onSameDocument from the old result
- * when the new result does not have them.
- * This can be extended in the future to resolve other conflicts as needed,
- * e.g. compare timestamps or version numbers to determine which data is more recent.
- *
- * @param oldResult - The existing SyncBlockInstance object.
- * @param newResult - The new SyncBlockInstance object to merge.
- * @returns A merged SyncBlockInstance object.
- */
-export declare const resolveSyncBlockInstance: (oldResult: SyncBlockInstance, newResult: SyncBlockInstance) => SyncBlockInstance;

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

@@ -1,7 +0,0 @@
-import type { SyncBlockProduct } from '../common/types';
-export declare const parseResourceId: (resourceId: string) => {
-    contentId: string;
-    product: SyncBlockProduct;
-    uuid: string;
-} | undefined;
-export declare const createResourceIdForReference: (product: SyncBlockProduct, contentId: string, uuid: string) => string;

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

@@ -1 +0,0 @@
-export declare const fetchWithRetry: (url: string, options: RequestInit, retriesRemaining?: number, delay?: number) => Promise<Response>;

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

@@ -1,15 +0,0 @@
-import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
-import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { SyncBlockData, BlockInstanceId, ResourceId, SyncBlockNode, SyncBlockProduct } from '../common/types';
-export declare const stripAnnotationMarksFromJSONContent: <T extends JSONNode | undefined>(content: T[]) => T[];
-export declare const convertSyncBlockPMNodeToSyncBlockData: (node: PMNode) => SyncBlockData;
-export declare const createSyncBlockNode: (localId: BlockInstanceId, resourceId: ResourceId) => SyncBlockNode;
-export declare const convertSyncBlockJSONNodeToSyncBlockNode: (node: JSONNode) => SyncBlockNode | undefined;
-export declare const convertPMNodeToSyncBlockNode: (node: PMNode) => SyncBlockNode | undefined;
-export declare const convertPMNodesToSyncBlockNodes: (nodes: PMNode[]) => SyncBlockNode[];
-export declare const getContentIdAndProductFromResourceId: (resourceId: string) => {
-    sourceContentId: string;
-    sourceProduct: SyncBlockProduct;
-};
-export declare const getSourceProductFromResourceIdSafe: (resourceId?: string) => SyncBlockProduct | undefined;
-export declare const convertContentUpdatedAt: (contentUpdatedAt: number | undefined) => string | undefined;

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

@@ -1,3 +0,0 @@
-import type { SyncBlockProduct, SyncBlockStatus } from '../common/types';
-export declare const normaliseSyncBlockProduct: (value: string | null | undefined) => SyncBlockProduct | undefined;
-export declare const normaliseSyncBlockStatus: (value: string | null | undefined) => SyncBlockStatus | undefined;