@atlaskit/editor-synced-block-provider 6.5.2 → 6.5.3

package/dist/types/clients/jira/sourceInfo.d.ts

@@ -1,2 +1,22 @@
 import type { SyncBlockSourceInfo } from '../../providers/types';
+/**
+ * Fetch source-info metadata for a Jira work item used by reference sync blocks.
+ *
+ * Parity notes vs the Confluence equivalent (`fetchConfluencePageInfo`):
+ *
+ * - **Archived / draft URL variants** are intentionally omitted. Confluence pages can be
+ *   "unpublished" (draft, archived, in-trash) and need REST fallbacks plus alternate URL
+ *   shapes. Jira work items have no equivalent lifecycle — an issue either exists in AGG
+ *   or it does not — so a single `webUrl` is sufficient.
+ *
+ * - **`#block-{localId}` deep-link anchor** is intentionally not appended. The current
+ *   Jira issue view does not implement scroll-to-anchor for unknown fragments, so the
+ *   anchor would be dead weight on the URL. The dispatching code in
+ *   `syncBlockProvider.fetchSyncBlockSourceInfo` deliberately does not pass `localId`
+ *   here for the same reason. If/when Jira issue view supports anchor scrolling for
+ *   sync-block local IDs, accept `localId?: string` here and append `#block-{localId}`.
+ *
+ * - **`subType` / page-type variants** are not modeled — Jira issue type is exposed via
+ *   the separate `issueType` field returned alongside `summary` / `webUrl`.
+ */
 export declare const fetchJiraWorkItemInfo: (workItemAri: string, hasAccess: boolean) => Promise<SyncBlockSourceInfo | undefined>;

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

@@ -1,6 +1,6 @@
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
-import type { SyncBlockInstance, SyncBlockSourceInfo } from '../providers/types';
+import type { SyncBlockInstance, SyncBlockJiraIssueType, SyncBlockSourceInfo } from '../providers/types';
 import type { SYNC_BLOCK_PRODUCTS } from './consts';
 export type BlockInstanceId = string;
 export type ResourceId = string;
@@ -36,6 +36,7 @@ export interface SyncBlockData {
     createdAt?: string;
     createdBy?: string;
     deletionReason?: DeletionReason;
+    issueType?: SyncBlockJiraIssueType;
     isSynced?: boolean;
     /**
      * Whether the block is on the same page as the source block

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

@@ -27,12 +27,29 @@ export type DeleteSyncBlockResult = {
     resourceId: ResourceId;
     success: boolean;
 };
+/**
+ * Lightweight metadata for a Jira issue's type, surfaced so consumers can render the
+ * correct ADS issue-type icon (Task / Bug / Story / Epic / Subtask) or fall back to the
+ * AGG-provided `iconUrl` for custom types. Optional throughout — Confluence references
+ * leave it `undefined`.
+ */
+export type SyncBlockJiraIssueType = {
+    /** AGG-served icon URL (from `avatar.xsmall`) — used as the fallback when no ADS icon matches `name`. */
+    iconUrl?: string;
+    /** Display name of the issue type, e.g. `"Task"`, `"Bug"`, `"Story"`. */
+    name: string;
+};
 export type SyncBlockSourceInfo = {
     hasAccess?: boolean;
     /**
      * Whether the source info is for a source synced block
      */
     isSource?: boolean;
+    /**
+     * Issue-type metadata for `productType === 'jira-work-item'` references. Always
+     * `undefined` for Confluence references.
+     */
+    issueType?: SyncBlockJiraIssueType;
     onSameDocument?: boolean;
     productType?: SyncBlockProduct;
     sourceAri: string;

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

@@ -1,20 +1,21 @@
 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) => OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, T, {
+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) => RendererSyncBlockEventPayload;
-export declare const getSourceInfoErrorPayload: (error: string, resourceId?: string) => RendererSyncBlockEventPayload;
-export declare const updateErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
-export declare const updateReferenceErrorPayload: (error: string, resourceId?: string) => RendererSyncBlockEventPayload;
-export declare const createErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
-export declare const deleteErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
-export declare const updateCacheErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
-export declare const fetchReferencesErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+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;
+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) => SyncBlockEventPayload;
+export declare const createSuccessPayload: (resourceId: string, sourceProduct?: string) => SyncBlockEventPayload;
 export declare const createSuccessPayloadNew: (resourceId: string) => SyncBlockEventPayload;
-export declare const updateSuccessPayload: (resourceId: string, hasReference?: boolean) => SyncBlockEventPayload;
-export declare const deleteSuccessPayload: (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/utils/utils.d.ts

@@ -7,7 +7,9 @@ export declare const convertSyncBlockJSONNodeToSyncBlockNode: (node: JSONNode) =
 export declare const convertPMNodeToSyncBlockNode: (node: PMNode) => SyncBlockNode | undefined;
 export declare const convertPMNodesToSyncBlockNodes: (nodes: PMNode[]) => SyncBlockNode[];
 export declare const getContentIdAndProductFromResourceId: (resourceId: string) => {
-    sourceProduct: SyncBlockProduct;
     sourceContentId: string;
+    sourceProduct: SyncBlockProduct;
 };
+export declare const getSourceProductFromResourceIdSafe: (resourceId?: string) => SyncBlockProduct | undefined;
+export declare const productAttrIfGateOn: (resourceId?: string) => SyncBlockProduct | undefined;
 export declare const convertContentUpdatedAt: (contentUpdatedAt: number | undefined) => string | undefined;

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

@@ -1,2 +1,22 @@
 import type { SyncBlockSourceInfo } from '../../providers/types';
+/**
+ * Fetch source-info metadata for a Jira work item used by reference sync blocks.
+ *
+ * Parity notes vs the Confluence equivalent (`fetchConfluencePageInfo`):
+ *
+ * - **Archived / draft URL variants** are intentionally omitted. Confluence pages can be
+ *   "unpublished" (draft, archived, in-trash) and need REST fallbacks plus alternate URL
+ *   shapes. Jira work items have no equivalent lifecycle — an issue either exists in AGG
+ *   or it does not — so a single `webUrl` is sufficient.
+ *
+ * - **`#block-{localId}` deep-link anchor** is intentionally not appended. The current
+ *   Jira issue view does not implement scroll-to-anchor for unknown fragments, so the
+ *   anchor would be dead weight on the URL. The dispatching code in
+ *   `syncBlockProvider.fetchSyncBlockSourceInfo` deliberately does not pass `localId`
+ *   here for the same reason. If/when Jira issue view supports anchor scrolling for
+ *   sync-block local IDs, accept `localId?: string` here and append `#block-{localId}`.
+ *
+ * - **`subType` / page-type variants** are not modeled — Jira issue type is exposed via
+ *   the separate `issueType` field returned alongside `summary` / `webUrl`.
+ */
 export declare const fetchJiraWorkItemInfo: (workItemAri: string, hasAccess: boolean) => Promise<SyncBlockSourceInfo | undefined>;

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

@@ -1,6 +1,6 @@
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
-import type { SyncBlockInstance, SyncBlockSourceInfo } from '../providers/types';
+import type { SyncBlockInstance, SyncBlockJiraIssueType, SyncBlockSourceInfo } from '../providers/types';
 import type { SYNC_BLOCK_PRODUCTS } from './consts';
 export type BlockInstanceId = string;
 export type ResourceId = string;
@@ -36,6 +36,7 @@ export interface SyncBlockData {
     createdAt?: string;
     createdBy?: string;
     deletionReason?: DeletionReason;
+    issueType?: SyncBlockJiraIssueType;
     isSynced?: boolean;
     /**
      * Whether the block is on the same page as the source block

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

@@ -27,12 +27,29 @@ export type DeleteSyncBlockResult = {
     resourceId: ResourceId;
     success: boolean;
 };
+/**
+ * Lightweight metadata for a Jira issue's type, surfaced so consumers can render the
+ * correct ADS issue-type icon (Task / Bug / Story / Epic / Subtask) or fall back to the
+ * AGG-provided `iconUrl` for custom types. Optional throughout — Confluence references
+ * leave it `undefined`.
+ */
+export type SyncBlockJiraIssueType = {
+    /** AGG-served icon URL (from `avatar.xsmall`) — used as the fallback when no ADS icon matches `name`. */
+    iconUrl?: string;
+    /** Display name of the issue type, e.g. `"Task"`, `"Bug"`, `"Story"`. */
+    name: string;
+};
 export type SyncBlockSourceInfo = {
     hasAccess?: boolean;
     /**
      * Whether the source info is for a source synced block
      */
     isSource?: boolean;
+    /**
+     * Issue-type metadata for `productType === 'jira-work-item'` references. Always
+     * `undefined` for Confluence references.
+     */
+    issueType?: SyncBlockJiraIssueType;
     onSameDocument?: boolean;
     productType?: SyncBlockProduct;
     sourceAri: string;

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

@@ -1,20 +1,21 @@
 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) => OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, T, {
+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) => RendererSyncBlockEventPayload;
-export declare const getSourceInfoErrorPayload: (error: string, resourceId?: string) => RendererSyncBlockEventPayload;
-export declare const updateErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
-export declare const updateReferenceErrorPayload: (error: string, resourceId?: string) => RendererSyncBlockEventPayload;
-export declare const createErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
-export declare const deleteErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
-export declare const updateCacheErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
-export declare const fetchReferencesErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+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;
+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) => SyncBlockEventPayload;
+export declare const createSuccessPayload: (resourceId: string, sourceProduct?: string) => SyncBlockEventPayload;
 export declare const createSuccessPayloadNew: (resourceId: string) => SyncBlockEventPayload;
-export declare const updateSuccessPayload: (resourceId: string, hasReference?: boolean) => SyncBlockEventPayload;
-export declare const deleteSuccessPayload: (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/utils.d.ts

@@ -7,7 +7,9 @@ export declare const convertSyncBlockJSONNodeToSyncBlockNode: (node: JSONNode) =
 export declare const convertPMNodeToSyncBlockNode: (node: PMNode) => SyncBlockNode | undefined;
 export declare const convertPMNodesToSyncBlockNodes: (nodes: PMNode[]) => SyncBlockNode[];
 export declare const getContentIdAndProductFromResourceId: (resourceId: string) => {
-    sourceProduct: SyncBlockProduct;
     sourceContentId: string;
+    sourceProduct: SyncBlockProduct;
 };
+export declare const getSourceProductFromResourceIdSafe: (resourceId?: string) => SyncBlockProduct | undefined;
+export declare const productAttrIfGateOn: (resourceId?: string) => SyncBlockProduct | undefined;
 export declare const convertContentUpdatedAt: (contentUpdatedAt: number | undefined) => string | undefined;

package/package.json

@@ -29,7 +29,7 @@
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/node-data-provider": "^11.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^79.0.0",
+		"@atlaskit/tmp-editor-statsig": "^80.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0",
 		"graphql-ws": "^5.14.2",
@@ -38,7 +38,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^114.29.0",
+		"@atlaskit/editor-common": "^114.30.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -81,7 +81,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "6.5.2",
+	"version": "6.5.3",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -101,6 +101,9 @@
 		"platform_synced_block_patch_10": {
 			"type": "boolean"
 		},
+		"platform_synced_block_patch_11": {
+			"type": "boolean"
+		},
 		"platform_synced_block_add_info_web_socket_error": {
 			"type": "boolean"
 		}

package/types/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@atlaskit/editor-synced-block-provider/types",
+  "main": "../dist/cjs/providers/types.js",
+  "module": "../dist/esm/providers/types.js",
+  "module:es2019": "../dist/es2019/providers/types.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../dist/types/providers/types.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/providers/types.d.ts"
+      ]
+    }
+  }
+}

package/utils/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@atlaskit/editor-synced-block-provider/utils",
+  "main": "../dist/cjs/utils/utils.js",
+  "module": "../dist/esm/utils/utils.js",
+  "module:es2019": "../dist/es2019/utils/utils.js",
+  "sideEffects": [
+    "*.compiled.css"
+  ],
+  "types": "../dist/types/utils/utils.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/utils/utils.d.ts"
+      ]
+    }
+  }
+}