@atlaskit/editor-synced-block-provider 2.12.3 → 2.13.1

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

@@ -1,10 +1,18 @@
+import { type SyncBlockProduct } from '../../common/types';
 /**
- * Generates a unique block ARI from a source ARI and a local ID.
- * @param sourceId - the ARI of the document. E.G ari:cloud:confluence:cloudId:page/pageId
- * @param localId - the localId of the block node. A randomly generated UUID
- * @returns the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId
+ * Generates the block ARI from the source page ARI and the source block's resource ID.
+ * @param sourceAri - the ARI of the document. E.G ari:cloud:confluence:cloudId:page/pageId
+ * @param resourceId - the resource ID of the block node. A randomly generated UUID
+ * @returns the block ARI. E.G ari:cloud:blocks:<cloudId>:synced-block/<product>/<pageId>/<resourceId>
  */
-export declare const blockResourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;
+export declare const generateBlockAri: (sourceAri: string, resourceId: string, product: SyncBlockProduct) => string;
+/**
+ *
+ * @param sourceAri - the ARI of the document. E.G ari:cloud:confluence:cloudId:page/pageId
+ * @param resourceId - the resource ID of the reference synced block. E.G confluence-page/pageId/sourceResourceId
+ * @returns the block ARI. E.G ari:cloud:blocks:<cloudId>:synced-block/<product>/<pageId>/<resourceId>
+ */
+export declare const generateBlockAriFromReference: (sourceAri: string, resourceId: string) => string;
 /**
  * Extracts the local ID from a block ARI.
  * @param ari - the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId

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

@@ -29,6 +29,9 @@ export interface SyncBlockData {
     createdBy?: string;
     isSynced?: boolean;
     product?: SyncBlockProduct;
+    /**
+     * The ARI of the block. E.G ari:cloud:blocks:<cloudId>:synced-block/<product>/<pageId>/<resourceId>
+     */
     resourceId: ResourceId;
     sourceAri?: string;
     sourceTitle?: string;

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

@@ -4,7 +4,7 @@ export type { SyncBlockData, SyncBlockNode, SyncBlockProduct, BlockInstanceId, }
 export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } from './hooks/useFetchSyncBlockData';
 export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
-export { blockResourceIdFromSourceAndLocalId, getLocalIdFromBlockResourceId, } from './clients/block-service/ari';
+export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId, } from './clients/block-service/ari';
 export { getConfluencePageAri, getLocalIdFromConfluencePageAri, getPageARIFromContentPropertyResourceId, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId, } from './clients/confluence/ari';
 export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';

package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts

@@ -1,10 +1,12 @@
-import { SyncBlockError, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
+import { SyncBlockError, type ResourceId, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
 import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
 export declare const fetchReferences: (documentAri: string) => Promise<SyncBlockInstance[] | SyncBlockError>;
 /**
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
  */
 declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
+    private sourceAri;
+    constructor(sourceAri: string);
     fetchData(resourceId: string): Promise<SyncBlockInstance>;
 }
 /**
@@ -12,12 +14,13 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
  */
 declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     private sourceAri;
-    private product;
+    product: SyncBlockProduct;
     constructor(sourceAri: string, product: SyncBlockProduct);
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     createData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
-    generateResourceId(sourceAri: string, localId: string): string;
+    generateResourceIdForReference(sourceId: ResourceId): ResourceId;
+    generateResourceId(): ResourceId;
 }
 export declare const useMemoizedBlockServiceAPIProviders: (sourceAri: string, product: SyncBlockProduct) => {
     fetchProvider: BlockServiceADFFetchProvider;

package/dist/types-ts4.5/providers/confluence/confluenceContentAPI.d.ts

@@ -1,4 +1,4 @@
-import { type SyncBlockData } from '../../common/types';
+import { type ResourceId, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
 import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
 /**
  * Configuration for Content API providers
@@ -20,12 +20,14 @@ declare class ConfluenceADFFetchProvider implements ADFFetchProvider {
  */
 declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     private config;
+    product: SyncBlockProduct;
     constructor(config: ContentAPIConfig);
     private createNewContentProperty;
     writeData(syncBlockData: SyncBlockData): Promise<WriteSyncBlockResult>;
     createData(syncBlockData: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
     generateResourceId(sourceId: string, localId: string): string;
+    generateResourceIdForReference(sourceId: ResourceId): ResourceId;
 }
 /**
  * Convenience function to create providers with default content property key

package/dist/types-ts4.5/providers/syncBlockProvider.d.ts

@@ -17,6 +17,7 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * @param nestedRendererDataProviders
      */
     constructor(fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions);
+    getProduct(): SyncBlockProduct | undefined;
     /**
      * Check if the node is supported by the provider
      *
@@ -77,6 +78,7 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      */
     fetchSyncBlockSourceInfo(localId: BlockInstanceId, sourceAri: string, sourceProduct: SyncBlockProduct, fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): Promise<SyncBlockSourceInfo | undefined>;
     generateResourceId(sourceId: string, localId: BlockInstanceId): string;
+    generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     /**
      * Get the synced block renderer provider options
      *

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

@@ -13,6 +13,9 @@ import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBloc
 export type SyncBlockInstance = {
     data?: SyncBlockData;
     error?: SyncBlockError;
+    /**
+     *  The resourceId in the attrs of the block
+     */
     resourceId: ResourceId;
 };
 export type DeleteSyncBlockResult = {
@@ -43,6 +46,8 @@ export interface ADFWriteProvider {
     createData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
     deleteData: (resourceId: ResourceId) => Promise<DeleteSyncBlockResult>;
     generateResourceId: (sourceId: string, localId: string) => ResourceId;
+    generateResourceIdForReference: (sourceId: ResourceId) => ResourceId;
+    product: SyncBlockProduct;
     writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
 export type MediaEmojiProviderOptions = {
@@ -67,6 +72,7 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
     abstract createNodeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
+    abstract getProduct(): SyncBlockProduct | undefined;
     abstract fetchSyncBlockSourceInfo(localId: BlockInstanceId, sourceAri: string, sourceProduct: SyncBlockProduct, fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): Promise<SyncBlockSourceInfo | undefined>;
     abstract getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
     abstract retrieveSyncBlockParentInfo(sourceAri: string, sourceProduct: SyncBlockProduct): SyncBlockParentInfo | undefined;
@@ -77,6 +83,7 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
      * @returns The generated resource ID
      */
     abstract generateResourceId(sourceId: ResourceId, localId: BlockInstanceId): ResourceId;
+    abstract generateResourceIdForReference(sourceId: ResourceId): ResourceId;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
 export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -13,6 +13,7 @@ export declare class ReferenceSyncBlockStoreManager {
     private syncBlockURLRequests;
     private isRefreshingSubscriptions;
     constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void);
+    generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     /**
      * Refreshes the subscriptions for all sync blocks.

package/package.json

@@ -34,7 +34,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.39.0",
+		"@atlaskit/editor-common": "^110.40.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -77,7 +77,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.12.3",
+	"version": "2.13.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",