@atlaskit/editor-synced-block-provider 2.15.6 → 2.16.1

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

@@ -7,7 +7,7 @@ import { type SyncBlockProduct } from '../../common/types';
  */
 export declare const generateBlockAri: (sourceAri: string, resourceId: string, product: SyncBlockProduct) => string;
 /**
- *
+ * Generates the block ARI from the reference synced block ARI and the resource ID
  * @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>

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

@@ -72,6 +72,7 @@ export type DeleteSyncedBlockRequest = {
 export type UpdateSyncedBlockRequest = {
     blockAri: string;
     content: string;
+    stepVersion?: number;
 };
 export type CreateSyncedBlockRequest = {
     blockAri: string;
@@ -79,6 +80,7 @@ export type CreateSyncedBlockRequest = {
     content: string;
     product: SyncBlockProduct;
     sourceAri: string;
+    stepVersion?: number;
 };
 type ReferenceSyncedBlockIDs = {
     blockAri: string;
@@ -95,7 +97,7 @@ export declare class BlockError extends Error {
 }
 export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
-export declare const updateSyncedBlock: ({ blockAri, content, }: UpdateSyncedBlockRequest) => Promise<void>;
-export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
+export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, }: UpdateSyncedBlockRequest) => Promise<void>;
+export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
 export declare const updateReferenceSyncedBlockOnDocument: ({ documentAri, blocks, noContent, }: UpdateReferenceSyncedBlockOnDocumentRequest) => Promise<ReferenceSyncedBlockResponse | void>;
 export {};

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

@@ -1,9 +1,40 @@
+/**
+ * The type of the Confluence page
+ */
 export type PAGE_TYPE = 'page' | 'blogpost';
+/**
+ * Generates the Confluence page ARI
+ * @param pageId - the ID of the page
+ * @param cloudId - the cloud ID
+ * @param pageType - the type of the page
+ * @returns the Confluence page ARI
+ */
 export declare const getConfluencePageAri: (pageId: string, cloudId: string, pageType?: PAGE_TYPE) => string;
+/**
+ * Extracts the page ID and type from the Confluence page ARI
+ * @param ari - the Confluence page ARI
+ * @returns the page ID and type
+ */
 export declare const getPageIdAndTypeFromConfluencePageAri: (ari: string) => {
     id: string;
     type: PAGE_TYPE;
 };
-export declare const getLocalIdFromConfluencePageAri: (ari: string) => string;
-export declare const getPageARIFromContentPropertyResourceId: (resourceId: string) => string;
+/**
+ * Extracts the local ID from the Confluence page content property resource ID
+ * @param resourceId - the Confluence page content property resource ID
+ * @returns the local ID
+ */
+export declare const getLocalIdFromContentPropertyResourceId: (resourceId: string) => string;
+/**
+ * Extracts the Confluence page ARI from the Confluence content property resource ID
+ * @param resourceId - the Confluence content property resource ID
+ * @returns the Confluence page ARI
+ */
+export declare const getPageAriFromContentPropertyResourceId: (resourceId: string) => string;
+/**
+ * Generates the Confluence page content property resource ID from the source ID and local ID
+ * @param sourceId - the source ID
+ * @param localId - the local ID
+ * @returns the Confluence page content property resource ID
+ */
 export declare const resourceIdFromConfluencePageSourceIdAndLocalId: (sourceId: string, localId: string) => string;

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

@@ -0,0 +1,13 @@
+/**
+ * Generates the Jira work item ARI
+ * @param workItemId - the ID of the work item
+ * @param cloudId - the cloud ID
+ * @returns the Jira work item ARI
+ */
+export declare const getJiraWorkItemAri: (workItemId: string, cloudId: string) => string;
+/**
+ * Extracts the Jira work item ID from the Jira work item ARI
+ * @param ari - the Jira work item ARI
+ * @returns the Jira work item ID
+ */
+export declare const getJiraWorkItemIdFromAri: (ari: string) => string;

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

@@ -5,7 +5,8 @@ export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } from './hook
 export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId, } from './clients/block-service/ari';
-export { getConfluencePageAri, getLocalIdFromConfluencePageAri, getPageARIFromContentPropertyResourceId, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId, } from './clients/confluence/ari';
+export { getConfluencePageAri, getLocalIdFromContentPropertyResourceId, getPageAriFromContentPropertyResourceId, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId, } from './clients/confluence/ari';
+export { getJiraWorkItemAri, getJiraWorkItemIdFromAri } from './clients/jira/ari';
 export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';
 export { fetchConfluencePageInfo } from './clients/confluence/sourceInfo';

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

@@ -15,8 +15,9 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
 declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     private sourceAri;
     private sourceDocumentId;
+    private getVersion?;
     product: SyncBlockProduct;
-    constructor(sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string);
+    constructor(sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string, getVersion?: () => number | undefined);
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     createData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
@@ -24,7 +25,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     generateResourceId(): ResourceId;
     updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
-export declare const useMemoizedBlockServiceAPIProviders: (sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string) => {
+export declare const useMemoizedBlockServiceAPIProviders: (sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string, getVersion?: () => number | undefined) => {
     fetchProvider: BlockServiceADFFetchProvider;
     writeProvider: BlockServiceADFWriteProvider;
 };

package/package.json

@@ -33,7 +33,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.48.0",
+		"@atlaskit/editor-common": "^110.49.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -76,7 +76,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.15.6",
+	"version": "2.16.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",