@atlaskit/editor-synced-block-provider 3.30.2 → 3.30.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/cjs/clients/block-service/blockSubscription.js +3 -53
  3. package/dist/cjs/clients/block-service/sharedSubscriptionUtils.js +82 -0
  4. package/dist/cjs/index.js +46 -0
  5. package/dist/cjs/providers/block-service/blockServiceAPI.js +22 -6
  6. package/dist/cjs/store-manager/referenceSyncBlockStoreManager.js +25 -46
  7. package/dist/cjs/store-manager/syncBlockInMemorySessionCache.js +75 -0
  8. package/dist/cjs/utils/__generated__/relaySubscriptionUtilsSubscription.graphql.js +94 -0
  9. package/dist/cjs/utils/relayResponseConverter.js +76 -0
  10. package/dist/cjs/utils/relaySubscriptionUtils.js +130 -0
  11. package/dist/es2019/clients/block-service/blockSubscription.js +2 -67
  12. package/dist/es2019/clients/block-service/sharedSubscriptionUtils.js +91 -0
  13. package/dist/es2019/index.js +5 -0
  14. package/dist/es2019/providers/block-service/blockServiceAPI.js +22 -6
  15. package/dist/es2019/store-manager/referenceSyncBlockStoreManager.js +22 -43
  16. package/dist/es2019/store-manager/syncBlockInMemorySessionCache.js +57 -0
  17. package/dist/es2019/utils/__generated__/relaySubscriptionUtilsSubscription.graphql.js +88 -0
  18. package/dist/es2019/utils/relayResponseConverter.js +69 -0
  19. package/dist/es2019/utils/relaySubscriptionUtils.js +125 -0
  20. package/dist/esm/clients/block-service/blockSubscription.js +2 -52
  21. package/dist/esm/clients/block-service/sharedSubscriptionUtils.js +76 -0
  22. package/dist/esm/index.js +5 -0
  23. package/dist/esm/providers/block-service/blockServiceAPI.js +22 -6
  24. package/dist/esm/store-manager/referenceSyncBlockStoreManager.js +25 -46
  25. package/dist/esm/store-manager/syncBlockInMemorySessionCache.js +68 -0
  26. package/dist/esm/utils/__generated__/relaySubscriptionUtilsSubscription.graphql.js +88 -0
  27. package/dist/esm/utils/relayResponseConverter.js +69 -0
  28. package/dist/esm/utils/relaySubscriptionUtils.js +123 -0
  29. package/dist/types/clients/block-service/blockSubscription.d.ts +1 -26
  30. package/dist/types/clients/block-service/sharedSubscriptionUtils.d.ts +61 -0
  31. package/dist/types/index.d.ts +5 -0
  32. package/dist/types/providers/block-service/blockServiceAPI.d.ts +7 -2
  33. package/dist/types/store-manager/referenceSyncBlockStoreManager.d.ts +3 -3
  34. package/dist/types/store-manager/syncBlockInMemorySessionCache.d.ts +23 -0
  35. package/dist/types/utils/__generated__/relaySubscriptionUtilsSubscription.graphql.d.ts +31 -0
  36. package/dist/types/utils/relayResponseConverter.d.ts +47 -0
  37. package/dist/types/utils/relaySubscriptionUtils.d.ts +61 -0
  38. package/dist/types/utils/validValue.d.ts +1 -1
  39. package/dist/types-ts4.5/clients/block-service/blockSubscription.d.ts +1 -26
  40. package/dist/types-ts4.5/clients/block-service/sharedSubscriptionUtils.d.ts +61 -0
  41. package/dist/types-ts4.5/index.d.ts +5 -0
  42. package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts +7 -2
  43. package/dist/types-ts4.5/store-manager/referenceSyncBlockStoreManager.d.ts +3 -3
  44. package/dist/types-ts4.5/store-manager/syncBlockInMemorySessionCache.d.ts +23 -0
  45. package/dist/types-ts4.5/utils/__generated__/relaySubscriptionUtilsSubscription.graphql.d.ts +31 -0
  46. package/dist/types-ts4.5/utils/relayResponseConverter.d.ts +47 -0
  47. package/dist/types-ts4.5/utils/relaySubscriptionUtils.d.ts +61 -0
  48. package/dist/types-ts4.5/utils/validValue.d.ts +1 -1
  49. package/package.json +3 -2
@@ -0,0 +1,68 @@
1
+ import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
2
+ import _createClass from "@babel/runtime/helpers/createClass";
3
+ import _defineProperty from "@babel/runtime/helpers/defineProperty";
4
+ /**
5
+ * In-memory session cache for sync block data with size-based LRU eviction.
6
+ *
7
+ * Backed by a plain Map so that potentially private ADF content is never
8
+ * written to any browser-persistent storage (sessionStorage, localStorage,
9
+ * IndexedDB). The module-level singleton survives SPA transitions (no full
10
+ * page reload) and is naturally cleared on hard navigation or tab close.
11
+ *
12
+ * Uses JavaScript Map's insertion-order guarantee to implement LRU:
13
+ * on every read or write the accessed entry is moved to the end of the
14
+ * iteration order; when total cached size exceeds `maxSize`, the oldest
15
+ * (least-recently-used) entries are evicted first.
16
+ */
17
+ export var SyncBlockInMemorySessionCache = /*#__PURE__*/function () {
18
+ function SyncBlockInMemorySessionCache() {
19
+ var maxSize = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 5 * 1024 * 1024;
20
+ _classCallCheck(this, SyncBlockInMemorySessionCache);
21
+ _defineProperty(this, "store", new Map());
22
+ _defineProperty(this, "currentSize", 0);
23
+ this.maxSize = maxSize;
24
+ }
25
+ return _createClass(SyncBlockInMemorySessionCache, [{
26
+ key: "getItem",
27
+ value: function getItem(key) {
28
+ var value = this.store.get(key);
29
+ if (value === undefined) {
30
+ return null;
31
+ }
32
+ this.store.delete(key);
33
+ this.store.set(key, value);
34
+ return value;
35
+ }
36
+ }, {
37
+ key: "setItem",
38
+ value: function setItem(key, value) {
39
+ var existing = this.store.get(key);
40
+ if (existing !== undefined) {
41
+ this.currentSize -= existing.length;
42
+ this.store.delete(key);
43
+ }
44
+ this.store.set(key, value);
45
+ this.currentSize += value.length;
46
+ while (this.currentSize > this.maxSize && this.store.size > 1) {
47
+ var oldestKey = this.store.keys().next().value;
48
+ if (oldestKey !== undefined) {
49
+ var oldestValue = this.store.get(oldestKey);
50
+ if (oldestValue !== undefined) {
51
+ this.currentSize -= oldestValue.length;
52
+ }
53
+ this.store.delete(oldestKey);
54
+ }
55
+ }
56
+ }
57
+ }, {
58
+ key: "removeItem",
59
+ value: function removeItem(key) {
60
+ var value = this.store.get(key);
61
+ if (value !== undefined) {
62
+ this.currentSize -= value.length;
63
+ this.store.delete(key);
64
+ }
65
+ }
66
+ }]);
67
+ }();
68
+ export var syncBlockInMemorySessionCache = new SyncBlockInMemorySessionCache();
@@ -0,0 +1,88 @@
1
+ /**
2
+ * @generated SignedSource<<559b4fb25d0e5bc72be383427a939e2d>>
3
+ * @relayHash 38684212c43376e58fea2d6095011652
4
+ * @lightSyntaxTransform
5
+ * @nogrep
6
+ * @codegen-command: yarn relay
7
+ */
8
+
9
+ /* tslint:disable */
10
+ /* eslint-disable */
11
+ // @ts-nocheck
12
+
13
+ // @relayRequestID c84045a1f05bd1e73ade0a9d8b18462cc3dad5dcae1ebabab76b13135411c530
14
+
15
+ var node = function () {
16
+ var v0 = [{
17
+ "defaultValue": null,
18
+ "kind": "LocalArgument",
19
+ "name": "resourceId"
20
+ }],
21
+ v1 = [{
22
+ "args": [{
23
+ "kind": "Variable",
24
+ "name": "resourceId",
25
+ "variableName": "resourceId"
26
+ }],
27
+ "concreteType": "BlockServiceBlockPayload",
28
+ "kind": "LinkedField",
29
+ "name": "blockService_onBlockUpdated",
30
+ "plural": false,
31
+ "selections": [{
32
+ "kind": "ScalarField",
33
+ "name": "blockAri"
34
+ }, {
35
+ "kind": "ScalarField",
36
+ "name": "blockInstanceId"
37
+ }, {
38
+ "kind": "ScalarField",
39
+ "name": "content"
40
+ }, {
41
+ "kind": "ScalarField",
42
+ "name": "contentUpdatedAt"
43
+ }, {
44
+ "kind": "ScalarField",
45
+ "name": "createdAt"
46
+ }, {
47
+ "kind": "ScalarField",
48
+ "name": "createdBy"
49
+ }, {
50
+ "kind": "ScalarField",
51
+ "name": "deletionReason"
52
+ }, {
53
+ "kind": "ScalarField",
54
+ "name": "product"
55
+ }, {
56
+ "kind": "ScalarField",
57
+ "name": "sourceAri"
58
+ }, {
59
+ "kind": "ScalarField",
60
+ "name": "status"
61
+ }]
62
+ }];
63
+ return {
64
+ "fragment": {
65
+ "argumentDefinitions": v0 /*: any*/,
66
+ "kind": "Fragment",
67
+ "name": "relaySubscriptionUtilsSubscription",
68
+ "selections": v1 /*: any*/,
69
+ "type": "Subscription"
70
+ },
71
+ "kind": "Request",
72
+ "operation": {
73
+ "argumentDefinitions": v0 /*: any*/,
74
+ "kind": "Operation",
75
+ "name": "relaySubscriptionUtilsSubscription",
76
+ "selections": v1 /*: any*/
77
+ },
78
+ "params": {
79
+ "id": "c84045a1f05bd1e73ade0a9d8b18462cc3dad5dcae1ebabab76b13135411c530",
80
+ "metadata": {},
81
+ "name": "relaySubscriptionUtilsSubscription",
82
+ "operationKind": "subscription",
83
+ "text": null
84
+ }
85
+ };
86
+ }();
87
+ node.hash = "6f3ebc87921555436cad753ec1aead2e";
88
+ export default node;
@@ -0,0 +1,69 @@
1
+ import { parseSubscriptionPayload } from '../clients/block-service/sharedSubscriptionUtils';
2
+ import { normaliseSyncBlockStatus } from './validValue';
3
+ /**
4
+ * Converts parsed subscription data to SyncBlockInstance format.
5
+ *
6
+ * @param parsed - The parsed subscription data
7
+ * @param resourceId - The resource ID for the block
8
+ * @returns A SyncBlockInstance
9
+ */
10
+ export function convertParsedDataToSyncBlockInstance(parsed, resourceId) {
11
+ return {
12
+ data: {
13
+ content: parsed.content,
14
+ contentUpdatedAt: parsed.contentUpdatedAt,
15
+ resourceId: parsed.blockAri,
16
+ blockInstanceId: parsed.blockInstanceId,
17
+ sourceAri: parsed.sourceAri,
18
+ product: parsed.product,
19
+ createdAt: parsed.createdAt,
20
+ createdBy: parsed.createdBy,
21
+ status: normaliseSyncBlockStatus(parsed.status)
22
+ },
23
+ resourceId: resourceId
24
+ };
25
+ }
26
+
27
+ /**
28
+ * Converts a Relay subscription response to SyncBlockInstance format using shared parsing logic.
29
+
30
+ * @param response - The Relay subscription response containing block update data
31
+ * @param resourceId - The resource ID for the block
32
+ * @returns A SyncBlockInstance or null if parsing fails
33
+ *
34
+ * @example
35
+ * ```typescript
36
+ * // In a Relay subscription handler
37
+ * onNext: (response) => {
38
+ * if (response?.blockService_onBlockUpdated) {
39
+ * const syncBlockInstance = convertRelayResponseToSyncBlockInstance(
40
+ * response.blockService_onBlockUpdated,
41
+ * resourceId,
42
+ * );
43
+ * if (syncBlockInstance) {
44
+ * onUpdate(syncBlockInstance);
45
+ * }
46
+ * }
47
+ * }
48
+ * ```
49
+ */
50
+ export function convertRelayResponseToSyncBlockInstance(response, resourceId) {
51
+ var _response$contentUpda, _response$deletionRea;
52
+ var payload = {
53
+ blockAri: response.blockAri,
54
+ blockInstanceId: response.blockInstanceId,
55
+ content: response.content,
56
+ contentUpdatedAt: (_response$contentUpda = response.contentUpdatedAt) !== null && _response$contentUpda !== void 0 ? _response$contentUpda : undefined,
57
+ createdAt: response.createdAt,
58
+ createdBy: response.createdBy,
59
+ deletionReason: (_response$deletionRea = response.deletionReason) !== null && _response$deletionRea !== void 0 ? _response$deletionRea : undefined,
60
+ product: response.product,
61
+ sourceAri: response.sourceAri,
62
+ status: response.status
63
+ };
64
+ var parsed = parseSubscriptionPayload(payload);
65
+ if (!parsed) {
66
+ return null;
67
+ }
68
+ return convertParsedDataToSyncBlockInstance(parsed, resourceId);
69
+ }
@@ -0,0 +1,123 @@
1
+ import { requestSubscription } from 'relay-runtime';
2
+ import { generateBlockAriFromReference } from '../clients/block-service/ari';
3
+ import { subscribeToBlockUpdates as subscribeToBlockUpdatesWS } from '../clients/block-service/blockSubscription';
4
+ import relaySubscriptionUtilsSubscriptionDocument from './__generated__/relaySubscriptionUtilsSubscription.graphql';
5
+ import { convertRelayResponseToSyncBlockInstance, convertParsedDataToSyncBlockInstance } from './relayResponseConverter';
6
+
7
+ /**
8
+ * Configuration for creating a Relay block subscription.
9
+ */
10
+
11
+ /**
12
+ * Creates a Relay-based block subscription without needing to wrap providers.
13
+ * This is a clean utility function that can be used directly in components or hooks.
14
+ *
15
+ * @param config - Configuration for the subscription
16
+ * @returns An unsubscribe function to dispose the subscription
17
+ *
18
+ * @example
19
+ * ```typescript
20
+ * const unsubscribe = createRelayBlockSubscription({
21
+ * relayEnvironment: environment,
22
+ * cloudId: 'my-cloud-id',
23
+ * resourceId: 'my-resource-id',
24
+ * onUpdate: (blockInstance) => {
25
+ * console.log('Block updated:', blockInstance);
26
+ * },
27
+ * onError: (error) => {
28
+ * console.error('Subscription error:', error);
29
+ * }
30
+ * });
31
+ *
32
+ * // Later, when component unmounts or subscription is no longer needed
33
+ * unsubscribe();
34
+ * ```
35
+ */
36
+ export function createRelayBlockSubscription(config) {
37
+ var relayEnvironment = config.relayEnvironment,
38
+ cloudId = config.cloudId,
39
+ resourceId = config.resourceId,
40
+ onUpdate = config.onUpdate,
41
+ _onError = config.onError;
42
+
43
+ // Convert resourceId to blockAri for the subscription
44
+ var blockAri = generateBlockAriFromReference({
45
+ cloudId: cloudId,
46
+ resourceId: resourceId
47
+ });
48
+ var subscriptionQuery = relaySubscriptionUtilsSubscriptionDocument;
49
+
50
+ // Try to use Relay subscription first
51
+ try {
52
+ var disposable = requestSubscription(relayEnvironment, {
53
+ subscription: subscriptionQuery,
54
+ variables: {
55
+ resourceId: blockAri
56
+ },
57
+ onNext: function onNext(response) {
58
+ if (response !== null && response !== void 0 && response.blockService_onBlockUpdated) {
59
+ var syncBlockInstance = convertRelayResponseToSyncBlockInstance(response.blockService_onBlockUpdated, resourceId);
60
+ if (syncBlockInstance) {
61
+ onUpdate(syncBlockInstance);
62
+ } else {
63
+ _onError === null || _onError === void 0 || _onError(new Error('Failed to parse Relay block subscription payload'));
64
+ }
65
+ }
66
+ },
67
+ onError: function onError(error) {
68
+ _onError === null || _onError === void 0 || _onError(error);
69
+ }
70
+ });
71
+
72
+ // If subscription was successfully created, return the unsubscribe function
73
+ if (disposable) {
74
+ return function () {
75
+ disposable.dispose();
76
+ };
77
+ }
78
+ } catch (error) {
79
+ // If requestSubscription throws, fall back to WebSocket
80
+ _onError === null || _onError === void 0 || _onError(error instanceof Error ? error : new Error('Relay subscription failed'));
81
+ }
82
+
83
+ // Fallback to WebSocket subscription when Relay subscriptions aren't available
84
+ return subscribeToBlockUpdatesWS(blockAri, function (parsedData) {
85
+ var syncBlockInstance = convertParsedDataToSyncBlockInstance(parsedData, parsedData.resourceId);
86
+ onUpdate(syncBlockInstance);
87
+ }, function (error) {
88
+ _onError === null || _onError === void 0 || _onError(error);
89
+ });
90
+ }
91
+
92
+ /**
93
+ * Hook-like function to create a subscription function that can be passed to providers.
94
+ * This creates a function with the same signature as subscribeToBlockUpdates that uses Relay.
95
+ *
96
+ * @param cloudId - Cloud ID for generating block ARIs
97
+ * @param relayEnvironment - Optional Relay environment. If not provided, will attempt to use global environment
98
+ * @returns A function that can be used as subscribeToBlockUpdates in provider configurations
99
+ *
100
+ * @example
101
+ * ```typescript
102
+ * const relaySubscribeToBlockUpdates = createRelaySubscriptionFunction(cloudId, environment);
103
+ *
104
+ * // Can be used directly as a subscribeToBlockUpdates replacement
105
+ * const unsubscribe = relaySubscribeToBlockUpdates(resourceId, onUpdate, onError);
106
+ * ```
107
+ */
108
+ export function createRelaySubscriptionFunction(cloudId, relayEnvironment) {
109
+ return function (resourceId, onUpdate, onError) {
110
+ var environment = relayEnvironment;
111
+ if (!environment) {
112
+ onError === null || onError === void 0 || onError(new Error('Relay environment not available'));
113
+ return function () {};
114
+ }
115
+ return createRelayBlockSubscription({
116
+ relayEnvironment: environment,
117
+ cloudId: cloudId,
118
+ resourceId: resourceId,
119
+ onUpdate: onUpdate,
120
+ onError: onError
121
+ });
122
+ };
123
+ }
@@ -1,29 +1,4 @@
1
- import type { ADFEntity } from '@atlaskit/adf-utils/types';
2
- import type { SyncBlockProduct } from '../../common/types';
3
- export type BlockSubscriptionPayload = {
4
- blockAri: string;
5
- blockInstanceId: string;
6
- content: string;
7
- contentUpdatedAt?: number;
8
- createdAt: number;
9
- createdBy: string;
10
- deletionReason?: string;
11
- product: string;
12
- sourceAri: string;
13
- status: string;
14
- };
15
- export type ParsedBlockSubscriptionData = {
16
- blockAri: string;
17
- blockInstanceId: string;
18
- content: ADFEntity[];
19
- contentUpdatedAt?: string;
20
- createdAt?: string;
21
- createdBy: string;
22
- product: SyncBlockProduct;
23
- resourceId: string;
24
- sourceAri: string;
25
- status: string;
26
- };
1
+ import { type ParsedBlockSubscriptionData } from './sharedSubscriptionUtils';
27
2
  type SubscriptionCallback = (data: ParsedBlockSubscriptionData) => void;
28
3
  type ErrorCallback = (error: Error) => void;
29
4
  type Unsubscribe = () => void;
@@ -0,0 +1,61 @@
1
+ import type { ADFEntity } from '@atlaskit/adf-utils/types';
2
+ import type { SyncBlockProduct } from '../../common/types';
3
+ /**
4
+ * Shared GraphQL subscription query for block updates.
5
+ * This is the canonical subscription query used across all implementations.
6
+ */
7
+ 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";
8
+ /**
9
+ * Raw subscription payload from the GraphQL subscription.
10
+ * This represents the exact shape returned by the blockService_onBlockUpdated subscription.
11
+ */
12
+ export type BlockSubscriptionPayload = {
13
+ blockAri: string;
14
+ blockInstanceId: string;
15
+ content: string;
16
+ contentUpdatedAt?: number;
17
+ createdAt: number;
18
+ createdBy: string;
19
+ deletionReason?: string;
20
+ product: string;
21
+ sourceAri: string;
22
+ status: string;
23
+ };
24
+ /**
25
+ * Parsed and normalized block subscription data.
26
+ * This is the standardized format used across different subscription implementations.
27
+ */
28
+ export type ParsedBlockSubscriptionData = {
29
+ blockAri: string;
30
+ blockInstanceId: string;
31
+ content: ADFEntity[];
32
+ contentUpdatedAt?: string;
33
+ createdAt?: string;
34
+ createdBy: string;
35
+ product: SyncBlockProduct;
36
+ resourceId: string;
37
+ sourceAri: string;
38
+ status: string;
39
+ };
40
+ /**
41
+ * Extracts the resourceId from a block ARI.
42
+ * Block ARI format: ari:cloud:blocks:<cloudId>:synced-block/<resourceId>
43
+ * @param blockAri - The block ARI string
44
+ * @returns The resourceId portion of the ARI
45
+ */
46
+ export declare const extractResourceIdFromBlockAri: (blockAri: string) => string | null;
47
+ /**
48
+ * Converts a timestamp to ISO string.
49
+ * @param timestamp - Timestamp in milliseconds
50
+ * @returns ISO string or undefined if conversion fails
51
+ */
52
+ export declare const convertTimestampToISOString: (timestamp?: number) => string | undefined;
53
+ /**
54
+ * Parses the raw subscription payload into a standardized format.
55
+ * This function handles all the data transformation and error handling consistently
56
+ * across different subscription implementations.
57
+ *
58
+ * @param payload - The raw subscription payload
59
+ * @returns Parsed block data or null if parsing fails
60
+ */
61
+ export declare const parseSubscriptionPayload: (payload: BlockSubscriptionPayload) => ParsedBlockSubscriptionData | null;
@@ -15,7 +15,12 @@ export { fetchConfluencePageInfo } from './clients/confluence/sourceInfo';
15
15
  export { SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
16
16
  export type { ADFFetchProvider, ADFWriteProvider, BlockNodeIdentifiers, BlockSubscriptionErrorCallback, BlockUpdateCallback, SyncBlockDataProviderInterface, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, SyncedBlockRendererDataProviders, Unsubscribe, UpdateReferenceSyncBlockResult, WriteSyncBlockResult, SyncBlockParentInfo, SyncBlockSourceInfo, } from './providers/types';
17
17
  export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
18
+ export { SyncBlockInMemorySessionCache, syncBlockInMemorySessionCache, } from './store-manager/syncBlockInMemorySessionCache';
18
19
  export { SyncBlockStoreManager, useMemoizedSyncBlockStoreManager, } from './store-manager/syncBlockStoreManager';
20
+ export { BLOCK_SERVICE_SUBSCRIPTION_QUERY } from './clients/block-service/sharedSubscriptionUtils';
21
+ export { type BlockSubscriptionPayload, parseSubscriptionPayload } from './clients/block-service/sharedSubscriptionUtils';
22
+ export { convertRelayResponseToSyncBlockInstance, type RelayBlockUpdateResponse } from './utils/relayResponseConverter';
23
+ export { createRelayBlockSubscription, createRelaySubscriptionFunction, type RelayBlockSubscriptionConfig } from './utils/relaySubscriptionUtils';
19
24
  export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
20
25
  export { parseResourceId, createResourceIdForReference } from './utils/resourceId';
21
26
  export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, convertPMNodesToSyncBlockNodes, getContentIdAndProductFromResourceId, } from './utils/utils';
@@ -1,3 +1,4 @@
1
+ import type { IEnvironment } from 'relay-runtime';
1
2
  import { type BlockContentResponse } from '../../clients/block-service/blockService';
2
3
  import { SyncBlockError, type ReferenceSyncBlockData, type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
3
4
  import type { ADFFetchProvider, ADFWriteProvider, BlockNodeIdentifiers, DeleteSyncBlockResult, SyncBlockInstance, UpdateReferenceSyncBlockResult, WriteSyncBlockResult } from '../types';
@@ -36,6 +37,7 @@ export declare const batchFetchData: (cloudId: string, parentAri: string | undef
36
37
  interface BlockServiceADFFetchProviderProps {
37
38
  cloudId: string;
38
39
  parentAri: string | undefined;
40
+ relayEnvironment?: IEnvironment;
39
41
  }
40
42
  /**
41
43
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
@@ -43,7 +45,8 @@ interface BlockServiceADFFetchProviderProps {
43
45
  declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
44
46
  private cloudId;
45
47
  private parentAri;
46
- constructor({ cloudId, parentAri }: BlockServiceADFFetchProviderProps);
48
+ private relayEnvironment?;
49
+ constructor({ cloudId, parentAri, relayEnvironment }: BlockServiceADFFetchProviderProps);
47
50
  fetchData(resourceId: string): Promise<SyncBlockInstance>;
48
51
  fetchReferences(referenceResourceId: string): Promise<ReferenceSyncBlockData>;
49
52
  /**
@@ -54,6 +57,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
54
57
  batchFetchData(blockNodeIdentifiers: BlockNodeIdentifiers[]): Promise<SyncBlockInstance[]>;
55
58
  /**
56
59
  * Subscribes to real-time updates for a specific block using GraphQL WebSocket subscriptions.
60
+ * If a Relay environment is provided, uses Relay subscriptions; otherwise falls back to WebSocket.
57
61
  * @param resourceId - The resource ID of the block to subscribe to
58
62
  * @param onUpdate - Callback function invoked when the block is updated
59
63
  * @param onError - Optional callback function invoked on subscription errors
@@ -91,8 +95,9 @@ interface BlockServiceAPIProvidersProps {
91
95
  parentAri: string | undefined;
92
96
  parentId?: string;
93
97
  product: SyncBlockProduct;
98
+ relayEnvironment?: IEnvironment;
94
99
  }
95
- export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceAPIProvidersProps) => {
100
+ export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, relayEnvironment, }: BlockServiceAPIProvidersProps) => {
96
101
  fetchProvider: BlockServiceADFFetchProvider;
97
102
  writeProvider: BlockServiceADFWriteProvider;
98
103
  };
@@ -73,8 +73,8 @@ export declare class ReferenceSyncBlockStoreManager {
73
73
  generateResourceIdForReference(sourceId: ResourceId): ResourceId;
74
74
  updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
75
75
  getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;
76
- private updateCacheInSessionStorage;
77
- private getSyncBlockDataFromSessionStorage;
76
+ private updateSessionCache;
77
+ private getFromSessionCache;
78
78
  /**
79
79
  * Refreshes the subscriptions for all sync blocks.
80
80
  * This is a fallback polling mechanism when real-time subscriptions are not enabled.
@@ -125,7 +125,7 @@ export declare class ReferenceSyncBlockStoreManager {
125
125
  getFromCache(resourceId: ResourceId): SyncBlockInstance | undefined;
126
126
  private deleteFromCache;
127
127
  private debouncedBatchedFetchSyncBlocks;
128
- private setSSRDataInSessionStorage;
128
+ private setSSRDataInSessionCache;
129
129
  subscribeToSyncBlock(resourceId: string, localId: string, callback: SubscriptionCallback): () => void;
130
130
  subscribeToSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
131
131
  subscribe(node: PMNode, callback: SubscriptionCallback): () => void;
@@ -0,0 +1,23 @@
1
+ /**
2
+ * In-memory session cache for sync block data with size-based LRU eviction.
3
+ *
4
+ * Backed by a plain Map so that potentially private ADF content is never
5
+ * written to any browser-persistent storage (sessionStorage, localStorage,
6
+ * IndexedDB). The module-level singleton survives SPA transitions (no full
7
+ * page reload) and is naturally cleared on hard navigation or tab close.
8
+ *
9
+ * Uses JavaScript Map's insertion-order guarantee to implement LRU:
10
+ * on every read or write the accessed entry is moved to the end of the
11
+ * iteration order; when total cached size exceeds `maxSize`, the oldest
12
+ * (least-recently-used) entries are evicted first.
13
+ */
14
+ export declare class SyncBlockInMemorySessionCache {
15
+ private store;
16
+ private currentSize;
17
+ private maxSize;
18
+ constructor(maxSize?: number);
19
+ getItem(key: string): string | null;
20
+ setItem(key: string, value: string): void;
21
+ removeItem(key: string): void;
22
+ }
23
+ export declare const syncBlockInMemorySessionCache: SyncBlockInMemorySessionCache;
@@ -0,0 +1,31 @@
1
+ /**
2
+ * @generated SignedSource<<559b4fb25d0e5bc72be383427a939e2d>>
3
+ * @relayHash 38684212c43376e58fea2d6095011652
4
+ * @lightSyntaxTransform
5
+ * @nogrep
6
+ * @codegen-command: yarn relay
7
+ */
8
+ import type { ConcreteRequest } from 'relay-runtime';
9
+ export type relaySubscriptionUtilsSubscription$variables = {
10
+ resourceId: string;
11
+ };
12
+ export type relaySubscriptionUtilsSubscription$data = {
13
+ readonly blockService_onBlockUpdated: {
14
+ readonly blockAri: string;
15
+ readonly blockInstanceId: string;
16
+ readonly content: string;
17
+ readonly contentUpdatedAt: number | null | undefined;
18
+ readonly createdAt: number;
19
+ readonly createdBy: string;
20
+ readonly deletionReason: string | null | undefined;
21
+ readonly product: string;
22
+ readonly sourceAri: string;
23
+ readonly status: string;
24
+ } | null | undefined;
25
+ };
26
+ export type relaySubscriptionUtilsSubscription = {
27
+ response: relaySubscriptionUtilsSubscription$data;
28
+ variables: relaySubscriptionUtilsSubscription$variables;
29
+ };
30
+ declare const node: ConcreteRequest;
31
+ export default node;
@@ -0,0 +1,47 @@
1
+ import { type ParsedBlockSubscriptionData } from '../clients/block-service/sharedSubscriptionUtils';
2
+ import type { ResourceId } from '../common/types';
3
+ import type { SyncBlockInstance } from '../providers/types';
4
+ export type RelayBlockUpdateResponse = {
5
+ blockAri: string;
6
+ blockInstanceId: string;
7
+ content: string;
8
+ contentUpdatedAt?: number | null;
9
+ createdAt: number;
10
+ createdBy: string;
11
+ deletionReason?: string | null;
12
+ product: string;
13
+ sourceAri: string;
14
+ status: string;
15
+ };
16
+ /**
17
+ * Converts parsed subscription data to SyncBlockInstance format.
18
+ *
19
+ * @param parsed - The parsed subscription data
20
+ * @param resourceId - The resource ID for the block
21
+ * @returns A SyncBlockInstance
22
+ */
23
+ export declare function convertParsedDataToSyncBlockInstance(parsed: ParsedBlockSubscriptionData, resourceId: ResourceId): SyncBlockInstance;
24
+ /**
25
+ * Converts a Relay subscription response to SyncBlockInstance format using shared parsing logic.
26
+
27
+ * @param response - The Relay subscription response containing block update data
28
+ * @param resourceId - The resource ID for the block
29
+ * @returns A SyncBlockInstance or null if parsing fails
30
+ *
31
+ * @example
32
+ * ```typescript
33
+ * // In a Relay subscription handler
34
+ * onNext: (response) => {
35
+ * if (response?.blockService_onBlockUpdated) {
36
+ * const syncBlockInstance = convertRelayResponseToSyncBlockInstance(
37
+ * response.blockService_onBlockUpdated,
38
+ * resourceId,
39
+ * );
40
+ * if (syncBlockInstance) {
41
+ * onUpdate(syncBlockInstance);
42
+ * }
43
+ * }
44
+ * }
45
+ * ```
46
+ */
47
+ export declare function convertRelayResponseToSyncBlockInstance(response: RelayBlockUpdateResponse, resourceId: ResourceId): SyncBlockInstance | null;