@atlaskit/editor-plugin-card 13.1.17 → 13.1.18

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-card
 
+## 13.1.18
+
+### Patch Changes
+
+- [`82c0224977f47`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/82c0224977f47) -
+  Update README.md and 0-intro.tsx
+- Updated dependencies
+
 ## 13.1.17
 
 ### Patch Changes

package/README.md

@@ -1,10 +1,23 @@
-# Editor plugin card
+# Editor Plugin Card
 
 Card plugin for @atlaskit/editor-core
 
 **Note:** This component is designed for internal Atlassian development.
 External contributors will be able to use this component but will not be able to submit issues.
 
+## Overview
+
+The Card plugin enables smart card rendering and link resolution in the Atlassian Editor. It provides support for multiple card appearances (inline, block, embed), datasource rendering, and interactive link toolbars with rich customization options.
+
+## Key features
+
+- **Card appearances** - Support for inline, block, and embed card renderings with configurable layouts
+- **Link resolution** - Automatic resolution and upgrading of links to smart cards via the card provider
+- **Datasource support** - Integration with datasource modals for Jira, Confluence, and Assets
+- **Link toolbar** - Interactive toolbar for editing links and managing card appearances
+- **Analytics integration** - Comprehensive event tracking for card interactions and view changes
+- **Configurable options** - Flexible options for enabling/disabling features like block cards, embeds, resizing, and alignment
+
 ## Install
 ---
 - **Install** - *yarn add @atlaskit/editor-plugin-card*
@@ -25,6 +38,7 @@ Please see [Atlaskit - Editor plugin card](https://atlaskit.atlassian.com/packag
 ## Support
 ---
 For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
+
 ## License
 ---
- Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.
+Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

package/dist/cjs/ui/analytics/events-from-tr.js

@@ -34,6 +34,7 @@ var findChanged = exports.findChanged = function findChanged(tr, state) {
   var updated = [];
   var queuedForUpgrade = isTransactionQueuedForUpgrade(tr);
   var isResolveReplace = isTransactionResolveReplace(tr);
+  var isAutoConvert = isAutoConvertTr(tr);
 
   // History
   var historyMeta = tr.getMeta(_utils.pmHistoryPluginKey);
@@ -118,9 +119,12 @@ var findChanged = exports.findChanged = function findChanged(tr, state) {
      * Skip "deletions" when the transaction is relating to
      * replacing links queued for upgrade to cards,
      * because the "deleted" link has not actually been
-     * tracked as "created" yet
+     * tracked as "created" yet.
+     * Also skip when the transaction is an auto-convert
+     * (e.g. a pasted link being converted to a native embed extension),
+     * because the link is being converted, not deleted by the user.
      */
-    if (!isResolveReplace) {
+    if (!isResolveReplace && !isAutoConvert) {
       removed.push.apply(removed, removedInStep);
     }
     inserted.push.apply(inserted, (0, _toConsumableArray2.default)(omitRequestsForUpgrade(insertedInStep)));
@@ -242,6 +246,20 @@ var isTransactionResolveReplace = function isTransactionResolveReplace(tr) {
   var pluginMeta = tr.getMeta(_pluginKey.pluginKey);
   return isMetadataResolve(pluginMeta);
 };
+
+/**
+ * Checks if the transaction is an auto-convert action
+ * (e.g. a pasted link being converted to a native embed extension node).
+ * In this case the link removal should not be tracked as a deletion.
+ */
+var isAutoConvertTr = function isAutoConvertTr(tr) {
+  return !!tr.steps.find(function (step) {
+    if (!(step instanceof _steps.LinkMetaStep)) {
+      return false;
+    }
+    return step.getMetadata().cardAction === 'AUTO_CONVERT';
+  });
+};
 var isMetadataResolve = function isMetadataResolve(metaData) {
   return hasType(metaData) && metaData.type === 'RESOLVE';
 };

package/dist/es2019/ui/analytics/events-from-tr.js

@@ -25,6 +25,7 @@ export const findChanged = (tr, state) => {
   const updated = [];
   const queuedForUpgrade = isTransactionQueuedForUpgrade(tr);
   const isResolveReplace = isTransactionResolveReplace(tr);
+  const isAutoConvert = isAutoConvertTr(tr);
 
   // History
   const historyMeta = tr.getMeta(pmHistoryPluginKey);
@@ -103,9 +104,12 @@ export const findChanged = (tr, state) => {
      * Skip "deletions" when the transaction is relating to
      * replacing links queued for upgrade to cards,
      * because the "deleted" link has not actually been
-     * tracked as "created" yet
+     * tracked as "created" yet.
+     * Also skip when the transaction is an auto-convert
+     * (e.g. a pasted link being converted to a native embed extension),
+     * because the link is being converted, not deleted by the user.
      */
-    if (!isResolveReplace) {
+    if (!isResolveReplace && !isAutoConvert) {
       removed.push(...removedInStep);
     }
     inserted.push(...omitRequestsForUpgrade(insertedInStep));
@@ -226,6 +230,20 @@ const isTransactionResolveReplace = tr => {
   const pluginMeta = tr.getMeta(pluginKey);
   return isMetadataResolve(pluginMeta);
 };
+
+/**
+ * Checks if the transaction is an auto-convert action
+ * (e.g. a pasted link being converted to a native embed extension node).
+ * In this case the link removal should not be tracked as a deletion.
+ */
+const isAutoConvertTr = tr => {
+  return !!tr.steps.find(step => {
+    if (!(step instanceof LinkMetaStep)) {
+      return false;
+    }
+    return step.getMetadata().cardAction === 'AUTO_CONVERT';
+  });
+};
 const isMetadataResolve = metaData => {
   return hasType(metaData) && metaData.type === 'RESOLVE';
 };

package/dist/esm/ui/analytics/events-from-tr.js

@@ -27,6 +27,7 @@ export var findChanged = function findChanged(tr, state) {
   var updated = [];
   var queuedForUpgrade = isTransactionQueuedForUpgrade(tr);
   var isResolveReplace = isTransactionResolveReplace(tr);
+  var isAutoConvert = isAutoConvertTr(tr);
 
   // History
   var historyMeta = tr.getMeta(pmHistoryPluginKey);
@@ -111,9 +112,12 @@ export var findChanged = function findChanged(tr, state) {
      * Skip "deletions" when the transaction is relating to
      * replacing links queued for upgrade to cards,
      * because the "deleted" link has not actually been
-     * tracked as "created" yet
+     * tracked as "created" yet.
+     * Also skip when the transaction is an auto-convert
+     * (e.g. a pasted link being converted to a native embed extension),
+     * because the link is being converted, not deleted by the user.
      */
-    if (!isResolveReplace) {
+    if (!isResolveReplace && !isAutoConvert) {
       removed.push.apply(removed, removedInStep);
     }
     inserted.push.apply(inserted, _toConsumableArray(omitRequestsForUpgrade(insertedInStep)));
@@ -235,6 +239,20 @@ var isTransactionResolveReplace = function isTransactionResolveReplace(tr) {
   var pluginMeta = tr.getMeta(pluginKey);
   return isMetadataResolve(pluginMeta);
 };
+
+/**
+ * Checks if the transaction is an auto-convert action
+ * (e.g. a pasted link being converted to a native embed extension node).
+ * In this case the link removal should not be tracked as a deletion.
+ */
+var isAutoConvertTr = function isAutoConvertTr(tr) {
+  return !!tr.steps.find(function (step) {
+    if (!(step instanceof LinkMetaStep)) {
+      return false;
+    }
+    return step.getMetadata().cardAction === 'AUTO_CONVERT';
+  });
+};
 var isMetadataResolve = function isMetadataResolve(metaData) {
   return hasType(metaData) && metaData.type === 'RESOLVE';
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-card",
-	"version": "13.1.17",
+	"version": "13.1.18",
 	"description": "Card plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",