@atlaskit/editor-synced-block-provider 12.1.5 → 12.2.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @atlaskit/editor-synced-block-provider
 
+## 12.2.1
+
+### Patch Changes
+
+- [`c5bc5493c5486`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c5bc5493c5486) -
+  Fix migrateSyncBlockIds mutating the caller's input ADF document. traverse() falls back to
+  mutating a node in place whenever its visitor returns undefined, so the transform now always
+  returns a copy instead.
+- Updated dependencies
+
+## 12.2.0
+
+### Minor Changes
+
+- [`6cf6b735bf90a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6cf6b735bf90a) -
+  Add migrateSyncBlockIds to the utils/resourceId entry point. Rewrites syncBlock and
+  bodiedSyncBlock identifiers so a document stays internally consistent after cloud-to-cloud
+  migration, preserving block UUIDs by default and supporting optional UUID regeneration.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 12.1.5
 
 ### Patch Changes

package/dist/cjs/entry-points/resourceId.js

@@ -9,10 +9,17 @@ Object.defineProperty(exports, "createResourceIdForReference", {
     return _resourceId.createResourceIdForReference;
   }
 });
+Object.defineProperty(exports, "migrateSyncBlockIds", {
+  enumerable: true,
+  get: function get() {
+    return _migrateSyncBlockIds.migrateSyncBlockIds;
+  }
+});
 Object.defineProperty(exports, "parseResourceId", {
   enumerable: true,
   get: function get() {
     return _resourceId.parseResourceId;
   }
 });
-var _resourceId = require("../utils/resourceId");
+var _resourceId = require("../utils/resourceId");
+var _migrateSyncBlockIds = require("../utils/migrateSyncBlockIds");

package/dist/cjs/utils/migrateSyncBlockIds.js

@@ -0,0 +1,108 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.migrateSyncBlockIds = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _traverse = require("@atlaskit/adf-utils/traverse");
+var _resourceId = require("./resourceId");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/*
+ * Rewrites `syncBlock`/`bodiedSyncBlock` identifiers so a document stays internally
+ * consistent after cloud-to-cloud migration or a copy to different host content.
+ *
+ * Source nodes (`bodiedSyncBlock`) carry a bare UUID as both `resourceId` and `localId` -
+ * the host content ID never appears in the ADF, only in the block ARI, which Block
+ * Service derives from the cloud ID and parent content ID at runtime. Reference nodes
+ * (`syncBlock`) carry `{product}/{contentId}/{sourceUuid}`. So preserving the UUID (the
+ * default) needs no edit on source nodes, and only remaps the `contentId` segment on
+ * references - which also keeps re-runs idempotent.
+ */
+
+/** Bails to `undefined` on anything that isn't a syncBlock/bodiedSyncBlock attrs shape. */
+var parseSyncBlockAttrs = function parseSyncBlockAttrs(attrs) {
+  var resourceId = attrs.resourceId,
+    localId = attrs.localId;
+  if (typeof resourceId !== 'string' || resourceId === '') {
+    return undefined;
+  }
+  return {
+    resourceId: resourceId,
+    localId: typeof localId === 'string' ? localId : undefined
+  };
+};
+var migrateAttrs = function migrateAttrs(attrs, resolvers, unresolvedContentIds) {
+  var _resolvers$resolveUui3;
+  var resourceId = attrs.resourceId,
+    localId = attrs.localId;
+  var parsed = (0, _resourceId.parseResourceId)(resourceId);
+  if (parsed) {
+    var _resolvers$resolveUui, _resolvers$resolveUui2;
+    var mappedContentId = resolvers.resolveContentId(parsed.contentId, parsed.product);
+    if (mappedContentId === undefined) {
+      unresolvedContentIds.add(parsed.contentId);
+    }
+    var nextContentId = mappedContentId !== null && mappedContentId !== void 0 ? mappedContentId : parsed.contentId;
+    var _nextUuid = (_resolvers$resolveUui = (_resolvers$resolveUui2 = resolvers.resolveUuid) === null || _resolvers$resolveUui2 === void 0 ? void 0 : _resolvers$resolveUui2.call(resolvers, parsed.uuid)) !== null && _resolvers$resolveUui !== void 0 ? _resolvers$resolveUui : parsed.uuid;
+    if (nextContentId === parsed.contentId && _nextUuid === parsed.uuid) {
+      return undefined;
+    }
+    return {
+      resourceId: (0, _resourceId.createResourceIdForReference)(parsed.product, nextContentId, _nextUuid),
+      // Only mirror the UUID when this node's localId tracked it in the first place.
+      localId: localId === parsed.uuid ? _nextUuid : localId
+    };
+  }
+
+  // bare-UUID source node: no content ID segment to remap
+  var nextUuid = (_resolvers$resolveUui3 = resolvers.resolveUuid) === null || _resolvers$resolveUui3 === void 0 ? void 0 : _resolvers$resolveUui3.call(resolvers, resourceId);
+  if (nextUuid === undefined || nextUuid === resourceId) {
+    return undefined;
+  }
+  return {
+    resourceId: nextUuid,
+    localId: localId === resourceId ? nextUuid : localId
+  };
+};
+
+/** `isTransformed` is `false` when no node changed, so callers can skip persisting the result. */
+var migrateSyncBlockIds = exports.migrateSyncBlockIds = function migrateSyncBlockIds(adf, resolvers) {
+  var unresolvedContentIds = new Set();
+  var isTransformed = false;
+
+  // Always returns a copy, even when nothing changes: traverse() falls back to mutating
+  // the original node in place (its `content` array gets reassigned) whenever a visitor
+  // returns undefined, so returning undefined here would leak that mutation onto the
+  // caller's input document.
+  var migrateNode = function migrateNode(node) {
+    var syncBlockAttrs = node.attrs && parseSyncBlockAttrs(node.attrs);
+    if (!syncBlockAttrs) {
+      return _objectSpread({}, node);
+    }
+    var nextAttrs = migrateAttrs(syncBlockAttrs, resolvers, unresolvedContentIds);
+    if (!nextAttrs) {
+      return _objectSpread({}, node);
+    }
+    isTransformed = true;
+    return _objectSpread(_objectSpread({}, node), {}, {
+      attrs: _objectSpread(_objectSpread({}, node.attrs), nextAttrs)
+    });
+  };
+  var transformedAdf = (0, _traverse.traverse)(adf, {
+    syncBlock: migrateNode,
+    bodiedSyncBlock: migrateNode
+  });
+
+  // traverse() only returns false when a visitor deletes the root node; migrateNode never does.
+  if (transformedAdf === false) {
+    throw new Error('migrateSyncBlockIds: traverse unexpectedly removed the root node');
+  }
+  return {
+    transformedAdf: transformedAdf,
+    isTransformed: isTransformed,
+    unresolvedContentIds: Array.from(unresolvedContentIds)
+  };
+};

package/dist/es2019/entry-points/resourceId.js

@@ -1,2 +1,3 @@
 /* eslint-disable @atlaskit/editor/no-re-export */
-export { parseResourceId, createResourceIdForReference } from '../utils/resourceId';
+export { parseResourceId, createResourceIdForReference } from '../utils/resourceId';
+export { migrateSyncBlockIds } from '../utils/migrateSyncBlockIds';

package/dist/es2019/utils/migrateSyncBlockIds.js

@@ -0,0 +1,111 @@
+import { traverse } from '@atlaskit/adf-utils/traverse';
+import { createResourceIdForReference, parseResourceId } from './resourceId';
+
+/*
+ * Rewrites `syncBlock`/`bodiedSyncBlock` identifiers so a document stays internally
+ * consistent after cloud-to-cloud migration or a copy to different host content.
+ *
+ * Source nodes (`bodiedSyncBlock`) carry a bare UUID as both `resourceId` and `localId` -
+ * the host content ID never appears in the ADF, only in the block ARI, which Block
+ * Service derives from the cloud ID and parent content ID at runtime. Reference nodes
+ * (`syncBlock`) carry `{product}/{contentId}/{sourceUuid}`. So preserving the UUID (the
+ * default) needs no edit on source nodes, and only remaps the `contentId` segment on
+ * references - which also keeps re-runs idempotent.
+ */
+
+/** Bails to `undefined` on anything that isn't a syncBlock/bodiedSyncBlock attrs shape. */
+const parseSyncBlockAttrs = attrs => {
+  const {
+    resourceId,
+    localId
+  } = attrs;
+  if (typeof resourceId !== 'string' || resourceId === '') {
+    return undefined;
+  }
+  return {
+    resourceId,
+    localId: typeof localId === 'string' ? localId : undefined
+  };
+};
+const migrateAttrs = (attrs, resolvers, unresolvedContentIds) => {
+  var _resolvers$resolveUui3;
+  const {
+    resourceId,
+    localId
+  } = attrs;
+  const parsed = parseResourceId(resourceId);
+  if (parsed) {
+    var _resolvers$resolveUui, _resolvers$resolveUui2;
+    const mappedContentId = resolvers.resolveContentId(parsed.contentId, parsed.product);
+    if (mappedContentId === undefined) {
+      unresolvedContentIds.add(parsed.contentId);
+    }
+    const nextContentId = mappedContentId !== null && mappedContentId !== void 0 ? mappedContentId : parsed.contentId;
+    const nextUuid = (_resolvers$resolveUui = (_resolvers$resolveUui2 = resolvers.resolveUuid) === null || _resolvers$resolveUui2 === void 0 ? void 0 : _resolvers$resolveUui2.call(resolvers, parsed.uuid)) !== null && _resolvers$resolveUui !== void 0 ? _resolvers$resolveUui : parsed.uuid;
+    if (nextContentId === parsed.contentId && nextUuid === parsed.uuid) {
+      return undefined;
+    }
+    return {
+      resourceId: createResourceIdForReference(parsed.product, nextContentId, nextUuid),
+      // Only mirror the UUID when this node's localId tracked it in the first place.
+      localId: localId === parsed.uuid ? nextUuid : localId
+    };
+  }
+
+  // bare-UUID source node: no content ID segment to remap
+  const nextUuid = (_resolvers$resolveUui3 = resolvers.resolveUuid) === null || _resolvers$resolveUui3 === void 0 ? void 0 : _resolvers$resolveUui3.call(resolvers, resourceId);
+  if (nextUuid === undefined || nextUuid === resourceId) {
+    return undefined;
+  }
+  return {
+    resourceId: nextUuid,
+    localId: localId === resourceId ? nextUuid : localId
+  };
+};
+
+/** `isTransformed` is `false` when no node changed, so callers can skip persisting the result. */
+export const migrateSyncBlockIds = (adf, resolvers) => {
+  const unresolvedContentIds = new Set();
+  let isTransformed = false;
+
+  // Always returns a copy, even when nothing changes: traverse() falls back to mutating
+  // the original node in place (its `content` array gets reassigned) whenever a visitor
+  // returns undefined, so returning undefined here would leak that mutation onto the
+  // caller's input document.
+  const migrateNode = node => {
+    const syncBlockAttrs = node.attrs && parseSyncBlockAttrs(node.attrs);
+    if (!syncBlockAttrs) {
+      return {
+        ...node
+      };
+    }
+    const nextAttrs = migrateAttrs(syncBlockAttrs, resolvers, unresolvedContentIds);
+    if (!nextAttrs) {
+      return {
+        ...node
+      };
+    }
+    isTransformed = true;
+    return {
+      ...node,
+      attrs: {
+        ...node.attrs,
+        ...nextAttrs
+      }
+    };
+  };
+  const transformedAdf = traverse(adf, {
+    syncBlock: migrateNode,
+    bodiedSyncBlock: migrateNode
+  });
+
+  // traverse() only returns false when a visitor deletes the root node; migrateNode never does.
+  if (transformedAdf === false) {
+    throw new Error('migrateSyncBlockIds: traverse unexpectedly removed the root node');
+  }
+  return {
+    transformedAdf,
+    isTransformed,
+    unresolvedContentIds: Array.from(unresolvedContentIds)
+  };
+};

package/dist/esm/entry-points/resourceId.js

@@ -1,2 +1,3 @@
 /* eslint-disable @atlaskit/editor/no-re-export */
-export { parseResourceId, createResourceIdForReference } from '../utils/resourceId';
+export { parseResourceId, createResourceIdForReference } from '../utils/resourceId';
+export { migrateSyncBlockIds } from '../utils/migrateSyncBlockIds';

package/dist/esm/utils/migrateSyncBlockIds.js

@@ -0,0 +1,102 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { traverse } from '@atlaskit/adf-utils/traverse';
+import { createResourceIdForReference, parseResourceId } from './resourceId';
+
+/*
+ * Rewrites `syncBlock`/`bodiedSyncBlock` identifiers so a document stays internally
+ * consistent after cloud-to-cloud migration or a copy to different host content.
+ *
+ * Source nodes (`bodiedSyncBlock`) carry a bare UUID as both `resourceId` and `localId` -
+ * the host content ID never appears in the ADF, only in the block ARI, which Block
+ * Service derives from the cloud ID and parent content ID at runtime. Reference nodes
+ * (`syncBlock`) carry `{product}/{contentId}/{sourceUuid}`. So preserving the UUID (the
+ * default) needs no edit on source nodes, and only remaps the `contentId` segment on
+ * references - which also keeps re-runs idempotent.
+ */
+
+/** Bails to `undefined` on anything that isn't a syncBlock/bodiedSyncBlock attrs shape. */
+var parseSyncBlockAttrs = function parseSyncBlockAttrs(attrs) {
+  var resourceId = attrs.resourceId,
+    localId = attrs.localId;
+  if (typeof resourceId !== 'string' || resourceId === '') {
+    return undefined;
+  }
+  return {
+    resourceId: resourceId,
+    localId: typeof localId === 'string' ? localId : undefined
+  };
+};
+var migrateAttrs = function migrateAttrs(attrs, resolvers, unresolvedContentIds) {
+  var _resolvers$resolveUui3;
+  var resourceId = attrs.resourceId,
+    localId = attrs.localId;
+  var parsed = parseResourceId(resourceId);
+  if (parsed) {
+    var _resolvers$resolveUui, _resolvers$resolveUui2;
+    var mappedContentId = resolvers.resolveContentId(parsed.contentId, parsed.product);
+    if (mappedContentId === undefined) {
+      unresolvedContentIds.add(parsed.contentId);
+    }
+    var nextContentId = mappedContentId !== null && mappedContentId !== void 0 ? mappedContentId : parsed.contentId;
+    var _nextUuid = (_resolvers$resolveUui = (_resolvers$resolveUui2 = resolvers.resolveUuid) === null || _resolvers$resolveUui2 === void 0 ? void 0 : _resolvers$resolveUui2.call(resolvers, parsed.uuid)) !== null && _resolvers$resolveUui !== void 0 ? _resolvers$resolveUui : parsed.uuid;
+    if (nextContentId === parsed.contentId && _nextUuid === parsed.uuid) {
+      return undefined;
+    }
+    return {
+      resourceId: createResourceIdForReference(parsed.product, nextContentId, _nextUuid),
+      // Only mirror the UUID when this node's localId tracked it in the first place.
+      localId: localId === parsed.uuid ? _nextUuid : localId
+    };
+  }
+
+  // bare-UUID source node: no content ID segment to remap
+  var nextUuid = (_resolvers$resolveUui3 = resolvers.resolveUuid) === null || _resolvers$resolveUui3 === void 0 ? void 0 : _resolvers$resolveUui3.call(resolvers, resourceId);
+  if (nextUuid === undefined || nextUuid === resourceId) {
+    return undefined;
+  }
+  return {
+    resourceId: nextUuid,
+    localId: localId === resourceId ? nextUuid : localId
+  };
+};
+
+/** `isTransformed` is `false` when no node changed, so callers can skip persisting the result. */
+export var migrateSyncBlockIds = function migrateSyncBlockIds(adf, resolvers) {
+  var unresolvedContentIds = new Set();
+  var isTransformed = false;
+
+  // Always returns a copy, even when nothing changes: traverse() falls back to mutating
+  // the original node in place (its `content` array gets reassigned) whenever a visitor
+  // returns undefined, so returning undefined here would leak that mutation onto the
+  // caller's input document.
+  var migrateNode = function migrateNode(node) {
+    var syncBlockAttrs = node.attrs && parseSyncBlockAttrs(node.attrs);
+    if (!syncBlockAttrs) {
+      return _objectSpread({}, node);
+    }
+    var nextAttrs = migrateAttrs(syncBlockAttrs, resolvers, unresolvedContentIds);
+    if (!nextAttrs) {
+      return _objectSpread({}, node);
+    }
+    isTransformed = true;
+    return _objectSpread(_objectSpread({}, node), {}, {
+      attrs: _objectSpread(_objectSpread({}, node.attrs), nextAttrs)
+    });
+  };
+  var transformedAdf = traverse(adf, {
+    syncBlock: migrateNode,
+    bodiedSyncBlock: migrateNode
+  });
+
+  // traverse() only returns false when a visitor deletes the root node; migrateNode never does.
+  if (transformedAdf === false) {
+    throw new Error('migrateSyncBlockIds: traverse unexpectedly removed the root node');
+  }
+  return {
+    transformedAdf: transformedAdf,
+    isTransformed: isTransformed,
+    unresolvedContentIds: Array.from(unresolvedContentIds)
+  };
+};

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

@@ -1 +1,3 @@
 export { parseResourceId, createResourceIdForReference } from '../utils/resourceId';
+export { migrateSyncBlockIds } from '../utils/migrateSyncBlockIds';
+export type { SyncBlockIdResolvers, SyncBlockIdMigrationResult, } from '../utils/migrateSyncBlockIds';

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

@@ -0,0 +1,16 @@
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
+import type { SyncBlockProduct } from '../common/types';
+export type SyncBlockIdResolvers = {
+    /** Return `undefined` for an unknown content ID - it's left untouched and reported via `unresolvedContentIds`. */
+    resolveContentId: (contentId: string, product: SyncBlockProduct) => string | undefined;
+    /** Omit to preserve UUIDs (recommended). Return `undefined` to preserve one UUID while remapping others. */
+    resolveUuid?: (uuid: string) => string | undefined;
+};
+export type SyncBlockIdMigrationResult = {
+    isTransformed: boolean;
+    transformedAdf: ADFEntity;
+    /** Reference content IDs with no mapping - a signal to investigate, not necessarily a failure. */
+    unresolvedContentIds: string[];
+};
+/** `isTransformed` is `false` when no node changed, so callers can skip persisting the result. */
+export declare const migrateSyncBlockIds: (adf: ADFEntity, resolvers: SyncBlockIdResolvers) => SyncBlockIdMigrationResult;

package/package.json

@@ -16,14 +16,14 @@
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-utils": "^20.8.0",
+		"@atlaskit/adf-utils": "^20.9.0",
 		"@atlaskit/browser-apis": "^1.2.0",
 		"@atlaskit/editor-json-transformer": "^9.8.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/node-data-provider": "^17.0.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
-		"@atlaskit/tmp-editor-statsig": "^173.0.0",
+		"@atlaskit/tmp-editor-statsig": "^174.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.2",
 		"bind-event-listener": "^3.0.0",
@@ -33,7 +33,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^120.11.0",
+		"@atlaskit/editor-common": "^120.13.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": "12.1.5",
+	"version": "12.2.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",