@atlaskit/editor-synced-block-provider 15.0.3 → 15.1.1

package/dist/types/common/types.d.ts

@@ -6,6 +6,12 @@ export type BlockInstanceId = string;
 export type ResourceId = string;
 export type SyncBlockProduct = (typeof SYNC_BLOCK_PRODUCTS)[number];
 export type SyncBlockStatus = 'active' | 'deleted' | 'unpublished';
+/**
+ * Where a synced block location sits relative to the document hosting the editor.
+ * `same-document` is the host document itself, the same page or the same work item field.
+ * `same-parent-document` is another field of the host work item.
+ */
+export type SyncBlockLocationScope = 'same-document' | 'same-parent-document' | 'elsewhere';
 export type SyncBlockAttrs = {
     localId: BlockInstanceId;
     resourceId: ResourceId;
@@ -36,8 +42,13 @@ export interface SyncBlockData {
     createdAt?: string;
     createdBy?: string;
     deletionReason?: DeletionReason;
+    /**
+     * Name of the Jira work item field holding the source block, as AGG localises it.
+     */
+    fieldName?: string;
     issueType?: SyncBlockJiraIssueType;
     isSynced?: boolean;
+    locationScope?: SyncBlockLocationScope;
     /**
      * Whether the block is on the same page as the source block
      */
@@ -64,6 +75,7 @@ export interface ReferenceSyncBlockResponse {
 }
 export interface ReferenceSyncBlock extends ReferenceSyncBlockResponse {
     hasAccess: boolean;
+    locationScope?: SyncBlockLocationScope;
     onSameDocument: boolean;
 }
 export type ReferenceSyncBlockData = {

package/dist/types/entry-points/common-types.d.ts

@@ -1,2 +1,2 @@
 export { SyncBlockError } from '../common/types';
-export type { ResourceId, SyncBlockData, SyncBlockNode, SyncBlockProduct, SyncBlockStatus, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, ReferencesSourceInfo, DeletionReason, DeletionMechanism, SyncBlockPrefetchData, } from '../common/types';
+export type { ResourceId, SyncBlockData, SyncBlockNode, SyncBlockProduct, SyncBlockLocationScope, SyncBlockStatus, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, ReferencesSourceInfo, DeletionReason, DeletionMechanism, SyncBlockPrefetchData, } from '../common/types';

package/dist/types/providers/types.d.ts

@@ -3,7 +3,7 @@ import type { EmojiProvider } from '@atlaskit/emoji';
 import type { MentionProvider } from '@atlaskit/mention/types';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { TaskDecisionProvider } from '@atlaskit/task-decision/types';
-import type { SyncBlockData, SyncBlockStatus, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, DeletionReason } from '../common/types';
+import type { SyncBlockData, SyncBlockStatus, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, DeletionReason, SyncBlockLocationScope } from '../common/types';
 type SyncBlockErrorInfo = {
     /**
      * PII-safe `Error.message` from the upstream catch, so the classifier can bucket
@@ -74,6 +74,10 @@ export type SyncBlockJiraIssueType = {
     name: string;
 };
 export type SyncBlockSourceInfo = {
+    /**
+     * Name of the Jira work item field holding the block, as AGG localises it.
+     */
+    fieldName?: string;
     hasAccess?: boolean;
     /**
      * Whether the source info is for a source synced block
@@ -84,6 +88,7 @@ export type SyncBlockSourceInfo = {
      * `undefined` for Confluence references.
      */
     issueType?: SyncBlockJiraIssueType;
+    locationScope?: SyncBlockLocationScope;
     onSameDocument?: boolean;
     productType?: SyncBlockProduct;
     sourceAri: string;

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

@@ -0,0 +1,16 @@
+import type { SyncBlockLocationScope, SyncBlockProduct } from '../common/types';
+/**
+ * The product check runs first so a Confluence-only document never reads the experiment.
+ */
+export declare const isFieldAwareJiraLocation: (productType: SyncBlockProduct | undefined) => boolean;
+/**
+ * Spreadable `{ locationScope }` for a location that should carry one, `undefined` otherwise.
+ * Without a host ARI there is nothing to compare against, so the experiment is not read.
+ */
+export declare const getFieldAwareLocationScope: ({ documentAri, hostAri, productType, }: {
+    documentAri: string;
+    hostAri: string | undefined;
+    productType: SyncBlockProduct | undefined;
+}) => {
+    locationScope: SyncBlockLocationScope;
+} | undefined;

package/package.json

@@ -23,7 +23,7 @@
 		"@atlaskit/node-data-provider": "^20.0.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
-		"@atlaskit/tmp-editor-statsig": "^202.0.0",
+		"@atlaskit/tmp-editor-statsig": "^204.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.2",
 		"bind-event-listener": "^3.0.0",
@@ -33,7 +33,7 @@
 		"uuid": "^11.1.1"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^123.5.0",
+		"@atlaskit/editor-common": "^123.8.0",
 		"react": "^18.2.0 || ^19.2.0"
 	},
 	"devDependencies": {
@@ -42,7 +42,7 @@
 		"react-dom": "^19.2.0"
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "15.0.3",
+	"version": "15.1.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",