@atlaskit/editor-card-provider 6.8.23 → 7.0.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @atlaskit/editor-card-provider
 
+## 7.0.0
+
+### Major Changes
+
+- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
+  Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
+
+  Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
+
+  Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
+
+  ```diff
+  - "typesVersions": {
+  -    ">=4.5 <4.9": {
+  -        "*": [
+  -            "dist/types-ts4.5/*",
+  -            "dist/types-ts4.5/index.d.ts"
+  -        ]
+  -    }
+  - },
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+
+## 6.8.24
+
+### Patch Changes
+
+- [`027beb2f61316`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/027beb2f61316) -
+  Update smart link appearance, if and only if smart link is created from confluence editor quick
+  insert menu
+
 ## 6.8.23
 
 ### Patch Changes

package/dist/cjs/provider.js

@@ -698,7 +698,23 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_No
         return _canBeResolvedAsEmbed.apply(this, arguments);
       }
       return canBeResolvedAsEmbed;
-    }())
+    }()
+    /**
+     * Opt-in hook: when a caller explicitly requests an `'embed'` appearance and the
+     * user has no saved preference for the URL, honour that request as the default
+     * (above any provider default), validating embeddability first and falling back
+     * to a card (`'block'`) when the link cannot be embedded.
+     *
+     * Defaults to `false` so behaviour is unchanged for every existing consumer.
+     * Subclasses (e.g. Confluence) can override this to opt in, typically behind an
+     * experiment.
+     */
+    )
+  }, {
+    key: "shouldHonorRequestedEmbedAsDefault",
+    value: function shouldHonorRequestedEmbedAsDefault() {
+      return false;
+    }
   }, {
     key: "getAuthStatusFromResolveResponse",
     value: function () {
@@ -787,7 +803,7 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_No
     key: "resolve",
     value: function () {
       var _resolve = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee11(url, appearance, shouldForceAppearance, isEmbedFriendlyLocation) {
-        var hardCodedAppearance, _yield$Promise$all, _yield$Promise$all2, matchedProviderPattern, userPreference, data, issueAri, _this$onResolve, isSupported, providerDefaultAppearance, isEmbedFriendlyLocationEvaluated, preferredAppearance, canItBeEmbed, datasource, id, parameters, authStatus, access, _t8, _t9;
+        var hardCodedAppearance, _yield$Promise$all, _yield$Promise$all2, matchedProviderPattern, userPreference, data, issueAri, _this$onResolve, isSupported, providerDefaultAppearance, isEmbedFriendlyLocationEvaluated, preferredAppearance, canItBeEmbed, _canItBeEmbed, datasource, id, parameters, authStatus, access, _t8, _t9;
         return _regenerator.default.wrap(function (_context11) {
           while (1) switch (_context11.prev = _context11.next) {
             case 0:
@@ -843,7 +859,7 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_No
             case 7:
               isSupported = _t8;
               if (!isSupported) {
-                _context11.next = 14;
+                _context11.next = 16;
                 break;
               }
               providerDefaultAppearance = matchedProviderPattern === null || matchedProviderPattern === void 0 ? void 0 : matchedProviderPattern.defaultView;
@@ -873,12 +889,22 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_No
                 preferredAppearance = 'inline';
               }
             case 9:
+              if (!(!userPreference && appearance === 'embed' && isEmbedFriendlyLocationEvaluated && this.shouldHonorRequestedEmbedAsDefault())) {
+                _context11.next = 11;
+                break;
+              }
               _context11.next = 10;
-              return this.getDatasourceFromResolveResponse(url);
+              return this.canBeResolvedAsEmbed(url);
             case 10:
+              _canItBeEmbed = _context11.sent;
+              preferredAppearance = _canItBeEmbed ? 'embed' : 'block';
+            case 11:
+              _context11.next = 12;
+              return this.getDatasourceFromResolveResponse(url);
+            case 12:
               datasource = _context11.sent;
               if (!datasource) {
-                _context11.next = 11;
+                _context11.next = 13;
                 break;
               }
               id = datasource.id, parameters = datasource.parameters;
@@ -891,42 +917,42 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_No
                   type: 'table'
                 }]
               }, url));
-            case 11:
+            case 13:
               if (!(isEmbedFriendlyLocationEvaluated && !userPreference)) {
-                _context11.next = 13;
+                _context11.next = 15;
                 break;
               }
-              _context11.next = 12;
+              _context11.next = 14;
               return this.getAuthStatusFromResolveResponse(url);
-            case 12:
+            case 14:
               authStatus = _context11.sent;
               if (!authStatus) {
-                _context11.next = 13;
+                _context11.next = 15;
                 break;
               }
               access = authStatus.access;
               if (!(access === 'unauthorized')) {
-                _context11.next = 13;
+                _context11.next = 15;
                 break;
               }
               return _context11.abrupt("return", this.transformer.toSmartlinkAdf(url, 'block'));
-            case 13:
+            case 15:
               return _context11.abrupt("return", this.transformer.toSmartlinkAdf(url, preferredAppearance));
-            case 14:
-              _context11.next = 16;
+            case 16:
+              _context11.next = 18;
               break;
-            case 15:
-              _context11.prev = 15;
+            case 17:
+              _context11.prev = 17;
               _t9 = _context11["catch"](0);
               // eslint-disable-next-line
               console.warn("Error when trying to check Smart Card url \"".concat(url, "\"").concat(_t9 instanceof Error ? " - ".concat(_t9.name, " ").concat(_t9.message) : ''), _t9);
-            case 16:
+            case 18:
               return _context11.abrupt("return", Promise.reject(undefined));
-            case 17:
+            case 19:
             case "end":
               return _context11.stop();
           }
-        }, _callee11, this, [[0, 15]]);
+        }, _callee11, this, [[0, 17]]);
       }));
       function resolve(_x1, _x10, _x11, _x12) {
         return _resolve.apply(this, arguments);

package/dist/es2019/provider.js

@@ -362,6 +362,20 @@ export class EditorCardProvider extends NodeDataProvider {
       return false;
     }
   }
+
+  /**
+   * Opt-in hook: when a caller explicitly requests an `'embed'` appearance and the
+   * user has no saved preference for the URL, honour that request as the default
+   * (above any provider default), validating embeddability first and falling back
+   * to a card (`'block'`) when the link cannot be embedded.
+   *
+   * Defaults to `false` so behaviour is unchanged for every existing consumer.
+   * Subclasses (e.g. Confluence) can override this to opt in, typically behind an
+   * experiment.
+   */
+  shouldHonorRequestedEmbedAsDefault() {
+    return false;
+  }
   async getAuthStatusFromResolveResponse(url) {
     try {
       const {
@@ -450,6 +464,17 @@ export class EditorCardProvider extends NodeDataProvider {
             preferredAppearance = 'inline';
           }
         }
+
+        // When a caller explicitly requested an embed (e.g. Confluence's quick-insert
+        // embed flow tags the inserted link) and the user has no saved preference for
+        // this URL, honour embed-by-default above the provider default — but only in an
+        // embed-friendly location (matching how hard-coded embeds are gated above) and
+        // only when the link can actually be embedded, otherwise fall back to a card.
+        // Gated behind a default-off opt-in hook so other consumers are unaffected.
+        if (!userPreference && appearance === 'embed' && isEmbedFriendlyLocationEvaluated && this.shouldHonorRequestedEmbedAsDefault()) {
+          const canItBeEmbed = await this.canBeResolvedAsEmbed(url);
+          preferredAppearance = canItBeEmbed ? 'embed' : 'block';
+        }
         const datasource = await this.getDatasourceFromResolveResponse(url);
         if (datasource) {
           const {

package/dist/esm/provider.js

@@ -690,7 +690,23 @@ export var EditorCardProvider = /*#__PURE__*/function (_NodeDataProvider) {
         return _canBeResolvedAsEmbed.apply(this, arguments);
       }
       return canBeResolvedAsEmbed;
-    }())
+    }()
+    /**
+     * Opt-in hook: when a caller explicitly requests an `'embed'` appearance and the
+     * user has no saved preference for the URL, honour that request as the default
+     * (above any provider default), validating embeddability first and falling back
+     * to a card (`'block'`) when the link cannot be embedded.
+     *
+     * Defaults to `false` so behaviour is unchanged for every existing consumer.
+     * Subclasses (e.g. Confluence) can override this to opt in, typically behind an
+     * experiment.
+     */
+    )
+  }, {
+    key: "shouldHonorRequestedEmbedAsDefault",
+    value: function shouldHonorRequestedEmbedAsDefault() {
+      return false;
+    }
   }, {
     key: "getAuthStatusFromResolveResponse",
     value: function () {
@@ -779,7 +795,7 @@ export var EditorCardProvider = /*#__PURE__*/function (_NodeDataProvider) {
     key: "resolve",
     value: function () {
       var _resolve = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee11(url, appearance, shouldForceAppearance, isEmbedFriendlyLocation) {
-        var hardCodedAppearance, _yield$Promise$all, _yield$Promise$all2, matchedProviderPattern, userPreference, data, issueAri, _this$onResolve, isSupported, providerDefaultAppearance, isEmbedFriendlyLocationEvaluated, preferredAppearance, canItBeEmbed, datasource, id, parameters, authStatus, access, _t8, _t9;
+        var hardCodedAppearance, _yield$Promise$all, _yield$Promise$all2, matchedProviderPattern, userPreference, data, issueAri, _this$onResolve, isSupported, providerDefaultAppearance, isEmbedFriendlyLocationEvaluated, preferredAppearance, canItBeEmbed, _canItBeEmbed, datasource, id, parameters, authStatus, access, _t8, _t9;
         return _regeneratorRuntime.wrap(function (_context11) {
           while (1) switch (_context11.prev = _context11.next) {
             case 0:
@@ -835,7 +851,7 @@ export var EditorCardProvider = /*#__PURE__*/function (_NodeDataProvider) {
             case 7:
               isSupported = _t8;
               if (!isSupported) {
-                _context11.next = 14;
+                _context11.next = 16;
                 break;
               }
               providerDefaultAppearance = matchedProviderPattern === null || matchedProviderPattern === void 0 ? void 0 : matchedProviderPattern.defaultView;
@@ -865,12 +881,22 @@ export var EditorCardProvider = /*#__PURE__*/function (_NodeDataProvider) {
                 preferredAppearance = 'inline';
               }
             case 9:
+              if (!(!userPreference && appearance === 'embed' && isEmbedFriendlyLocationEvaluated && this.shouldHonorRequestedEmbedAsDefault())) {
+                _context11.next = 11;
+                break;
+              }
               _context11.next = 10;
-              return this.getDatasourceFromResolveResponse(url);
+              return this.canBeResolvedAsEmbed(url);
             case 10:
+              _canItBeEmbed = _context11.sent;
+              preferredAppearance = _canItBeEmbed ? 'embed' : 'block';
+            case 11:
+              _context11.next = 12;
+              return this.getDatasourceFromResolveResponse(url);
+            case 12:
               datasource = _context11.sent;
               if (!datasource) {
-                _context11.next = 11;
+                _context11.next = 13;
                 break;
               }
               id = datasource.id, parameters = datasource.parameters;
@@ -883,42 +909,42 @@ export var EditorCardProvider = /*#__PURE__*/function (_NodeDataProvider) {
                   type: 'table'
                 }]
               }, url));
-            case 11:
+            case 13:
               if (!(isEmbedFriendlyLocationEvaluated && !userPreference)) {
-                _context11.next = 13;
+                _context11.next = 15;
                 break;
               }
-              _context11.next = 12;
+              _context11.next = 14;
               return this.getAuthStatusFromResolveResponse(url);
-            case 12:
+            case 14:
               authStatus = _context11.sent;
               if (!authStatus) {
-                _context11.next = 13;
+                _context11.next = 15;
                 break;
               }
               access = authStatus.access;
               if (!(access === 'unauthorized')) {
-                _context11.next = 13;
+                _context11.next = 15;
                 break;
               }
               return _context11.abrupt("return", this.transformer.toSmartlinkAdf(url, 'block'));
-            case 13:
+            case 15:
               return _context11.abrupt("return", this.transformer.toSmartlinkAdf(url, preferredAppearance));
-            case 14:
-              _context11.next = 16;
+            case 16:
+              _context11.next = 18;
               break;
-            case 15:
-              _context11.prev = 15;
+            case 17:
+              _context11.prev = 17;
               _t9 = _context11["catch"](0);
               // eslint-disable-next-line
               console.warn("Error when trying to check Smart Card url \"".concat(url, "\"").concat(_t9 instanceof Error ? " - ".concat(_t9.name, " ").concat(_t9.message) : ''), _t9);
-            case 16:
+            case 18:
               return _context11.abrupt("return", Promise.reject(undefined));
-            case 17:
+            case 19:
             case "end":
               return _context11.stop();
           }
-        }, _callee11, this, [[0, 15]]);
+        }, _callee11, this, [[0, 17]]);
       }));
       function resolve(_x1, _x10, _x11, _x12) {
         return _resolve.apply(this, arguments);

package/dist/types/provider.d.ts

@@ -65,6 +65,17 @@ export declare class EditorCardProvider extends NodeDataProvider<CardNode, JsonL
      * Make a /resolve call and find out if result has embed capability
      */
     private canBeResolvedAsEmbed;
+    /**
+     * Opt-in hook: when a caller explicitly requests an `'embed'` appearance and the
+     * user has no saved preference for the URL, honour that request as the default
+     * (above any provider default), validating embeddability first and falling back
+     * to a card (`'block'`) when the link cannot be embedded.
+     *
+     * Defaults to `false` so behaviour is unchanged for every existing consumer.
+     * Subclasses (e.g. Confluence) can override this to opt in, typically behind an
+     * experiment.
+     */
+    protected shouldHonorRequestedEmbedAsDefault(): boolean;
     private getAuthStatusFromResolveResponse;
     /**
      * Make a /resolve call and find out if result has datasource capability

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "6.8.23",
+	"version": "7.0.0",
 	"description": "Contains the EditorCardProvider, for determining smart card behaviour in the editor.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -18,33 +18,25 @@
 	"module": "dist/esm/index.js",
 	"module:es2019": "dist/es2019/index.js",
 	"types": "dist/types/index.d.ts",
-	"typesVersions": {
-		">=4.5 <4.9": {
-			"*": [
-				"dist/types-ts4.5/*",
-				"dist/types-ts4.5/index.d.ts"
-			]
-		}
-	},
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/editor-json-transformer": "^8.33.0",
-		"@atlaskit/feature-gate-js-client": "^5.8.0",
-		"@atlaskit/frontend-utilities": "^3.4.0",
-		"@atlaskit/json-ld-types": "^1.5.0",
-		"@atlaskit/link-client-extension": "^6.1.0",
-		"@atlaskit/link-extractors": "^2.7.0",
-		"@atlaskit/linking-common": "^9.13.0",
-		"@atlaskit/linking-types": "^14.4.0",
-		"@atlaskit/node-data-provider": "^12.0.0",
-		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^103.0.0",
+		"@atlaskit/editor-json-transformer": "^9.0.0",
+		"@atlaskit/feature-gate-js-client": "^6.0.0",
+		"@atlaskit/frontend-utilities": "^4.0.0",
+		"@atlaskit/json-ld-types": "^2.0.0",
+		"@atlaskit/link-client-extension": "^7.0.0",
+		"@atlaskit/link-extractors": "^3.0.0",
+		"@atlaskit/linking-common": "^10.0.0",
+		"@atlaskit/linking-types": "^15.0.0",
+		"@atlaskit/node-data-provider": "^13.0.0",
+		"@atlaskit/platform-feature-flags": "^2.0.0",
+		"@atlaskit/tmp-editor-statsig": "^104.0.0",
 		"@babel/runtime": "^7.0.0",
 		"dataloader": "^2.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/link-provider": "^4.7.0",
+		"@atlaskit/link-provider": "^5.0.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {