@atlaskit/link-datasource 1.20.0 → 1.22.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/link-datasource
 
+## 1.22.0
+
+### Minor Changes
+
+- [#70612](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/70612) [`87457cd97d6b`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/87457cd97d6b) - Exported `buildDatasourceAdf` utility.
+
+## 1.21.0
+
+### Minor Changes
+
+- [#67808](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/67808) [`0a06727747b2`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/0a06727747b2) - [ux] Adding new auth UI/UX to enable users to connect 3P datasource accounts.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 1.20.0
 
 ### Minor Changes

package/dist/cjs/common/utils/adf.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.buildDatasourceAdf = void 0;
+var buildDatasourceAdf = exports.buildDatasourceAdf = function buildDatasourceAdf(datasource, url) {
+  return {
+    type: 'blockCard',
+    attrs: {
+      url: url,
+      datasource: datasource
+    }
+  };
+};

package/dist/cjs/hooks/useDatasourceTableState.js

@@ -26,60 +26,67 @@ var useDatasourceTableState = exports.useDatasourceTableState = function useData
   var idFieldCount = 1;
   var keyFieldCount = 1;
   var _useState = (0, _react.useState)([]),
-    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
-    defaultVisibleColumnKeys = _useState2[0],
-    setDefaultVisibleColumnKeys = _useState2[1];
+    _useState2 = (0, _slicedToArray2.default)(_useState, 1),
+    initialEmptyArray = _useState2[0];
   var _useState3 = (0, _react.useState)([]),
     _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
-    lastRequestedFieldKeys = _useState4[0],
-    setLastRequestedFieldKeys = _useState4[1];
-  var _useState5 = (0, _react.useState)({
+    defaultVisibleColumnKeys = _useState4[0],
+    setDefaultVisibleColumnKeys = _useState4[1];
+  var _useState5 = (0, _react.useState)([]),
+    _useState6 = (0, _slicedToArray2.default)(_useState5, 2),
+    lastRequestedFieldKeys = _useState6[0],
+    setLastRequestedFieldKeys = _useState6[1];
+  var _useState7 = (0, _react.useState)({
       properties: []
     }),
-    _useState6 = (0, _slicedToArray2.default)(_useState5, 2),
-    fullSchema = _useState6[0],
-    setFullSchema = _useState6[1];
-  var _useState7 = (0, _react.useState)('empty'),
     _useState8 = (0, _slicedToArray2.default)(_useState7, 2),
-    status = _useState8[0],
-    setStatus = _useState8[1];
-  var _useState9 = (0, _react.useState)([]),
+    fullSchema = _useState8[0],
+    setFullSchema = _useState8[1];
+  var _useState9 = (0, _react.useState)('empty'),
     _useState10 = (0, _slicedToArray2.default)(_useState9, 2),
-    responseItems = _useState10[0],
-    setResponseItems = _useState10[1];
-  var _useState11 = (0, _react.useState)(true),
+    status = _useState10[0],
+    setStatus = _useState10[1];
+  var _useState11 = (0, _react.useState)([]),
     _useState12 = (0, _slicedToArray2.default)(_useState11, 2),
-    hasNextPage = _useState12[0],
-    setHasNextPage = _useState12[1];
-  var _useState13 = (0, _react.useState)(undefined),
+    authDetails = _useState12[0],
+    setAuthDetails = _useState12[1];
+  var _useState13 = (0, _react.useState)([]),
     _useState14 = (0, _slicedToArray2.default)(_useState13, 2),
-    nextCursor = _useState14[0],
-    setNextCursor = _useState14[1];
-  var _useState15 = (0, _react.useState)([]),
+    responseItems = _useState14[0],
+    setResponseItems = _useState14[1];
+  var _useState15 = (0, _react.useState)(true),
     _useState16 = (0, _slicedToArray2.default)(_useState15, 2),
-    columns = _useState16[0],
-    setColumns = _useState16[1];
+    hasNextPage = _useState16[0],
+    setHasNextPage = _useState16[1];
   var _useState17 = (0, _react.useState)(undefined),
     _useState18 = (0, _slicedToArray2.default)(_useState17, 2),
-    totalCount = _useState18[0],
-    setTotalCount = _useState18[1];
-  var _useState19 = (0, _react.useState)(false),
+    nextCursor = _useState18[0],
+    setNextCursor = _useState18[1];
+  var _useState19 = (0, _react.useState)([]),
     _useState20 = (0, _slicedToArray2.default)(_useState19, 2),
-    shouldForceRequest = _useState20[0],
-    setShouldForceRequest = _useState20[1];
-  var _useState21 = (0, _react.useState)([]),
+    columns = _useState20[0],
+    setColumns = _useState20[1];
+  var _useState21 = (0, _react.useState)(undefined),
     _useState22 = (0, _slicedToArray2.default)(_useState21, 2),
-    destinationObjectTypes = _useState22[0],
-    setDestinationObjectTypes = _useState22[1];
-  var _useState23 = (0, _react.useState)(),
+    totalCount = _useState22[0],
+    setTotalCount = _useState22[1];
+  var _useState23 = (0, _react.useState)(false),
     _useState24 = (0, _slicedToArray2.default)(_useState23, 2),
-    extensionKey = _useState24[0],
-    setExtensionKey = _useState24[1];
+    shouldForceRequest = _useState24[0],
+    setShouldForceRequest = _useState24[1];
+  var _useState25 = (0, _react.useState)([]),
+    _useState26 = (0, _slicedToArray2.default)(_useState25, 2),
+    destinationObjectTypes = _useState26[0],
+    setDestinationObjectTypes = _useState26[1];
+  var _useState27 = (0, _react.useState)(),
+    _useState28 = (0, _slicedToArray2.default)(_useState27, 2),
+    extensionKey = _useState28[0],
+    setExtensionKey = _useState28[1];
   var _useDatasourceClientE = (0, _linkClientExtension.useDatasourceClientExtension)(),
     getDatasourceData = _useDatasourceClientE.getDatasourceData,
     getDatasourceDetails = _useDatasourceClientE.getDatasourceDetails;
   var loadDatasourceDetails = (0, _react.useCallback)( /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
-    var _yield$getDatasourceD, access, schema, isColumnNotPresentInCurrentColumnsList, allColumns, newColumns;
+    var _yield$getDatasourceD, _yield$getDatasourceD2, access, auth, schema, isColumnNotPresentInCurrentColumnsList, allColumns, newColumns;
     return _regenerator.default.wrap(function _callee$(_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
@@ -96,20 +103,16 @@ var useDatasourceTableState = exports.useDatasourceTableState = function useData
           });
         case 5:
           _yield$getDatasourceD = _context.sent;
-          access = _yield$getDatasourceD.meta.access;
+          _yield$getDatasourceD2 = _yield$getDatasourceD.meta;
+          access = _yield$getDatasourceD2.access;
+          auth = _yield$getDatasourceD2.auth;
           schema = _yield$getDatasourceD.data.schema;
-          if (!(access === 'unauthorized')) {
-            _context.next = 11;
-            break;
-          }
-          setStatus('unauthorized');
-          return _context.abrupt("return");
-        case 11:
-          if (!(access === 'forbidden')) {
+          if (!(access === 'unauthorized' || access === 'forbidden')) {
             _context.next = 14;
             break;
           }
-          setStatus('forbidden');
+          setStatus(access);
+          setAuthDetails(auth || initialEmptyArray);
           return _context.abrupt("return");
         case 14:
           isColumnNotPresentInCurrentColumnsList = function isColumnNotPresentInCurrentColumnsList(col) {
@@ -146,7 +149,7 @@ var useDatasourceTableState = exports.useDatasourceTableState = function useData
           return _context.stop();
       }
     }, _callee, null, [[2, 20]]);
-  })), [captureError, columns, datasourceId, getDatasourceDetails, parameters]);
+  })), [captureError, columns, datasourceId, getDatasourceDetails, parameters, initialEmptyArray]);
   var applySchemaProperties = (0, _react.useCallback)(function (schema, fieldKeys) {
     var properties = schema.properties,
       _schema$defaultProper = schema.defaultProperties,
@@ -191,12 +194,13 @@ var useDatasourceTableState = exports.useDatasourceTableState = function useData
       shouldForceRequest,
       isFullSchemaLoaded,
       datasourceDataRequest,
-      _yield$getDatasourceD2,
       _yield$getDatasourceD3,
+      _yield$getDatasourceD4,
       access,
       _destinationObjectTypes,
       _extensionKey,
-      _yield$getDatasourceD4,
+      auth,
+      _yield$getDatasourceD5,
       items,
       nextPageCursor,
       _totalCount,
@@ -229,30 +233,25 @@ var useDatasourceTableState = exports.useDatasourceTableState = function useData
           _context2.next = 10;
           return getDatasourceData(datasourceId, datasourceDataRequest, shouldForceRequest);
         case 10:
-          _yield$getDatasourceD2 = _context2.sent;
-          _yield$getDatasourceD3 = _yield$getDatasourceD2.meta;
-          access = _yield$getDatasourceD3.access;
-          _destinationObjectTypes = _yield$getDatasourceD3.destinationObjectTypes;
-          _extensionKey = _yield$getDatasourceD3.extensionKey;
-          _yield$getDatasourceD4 = _yield$getDatasourceD2.data;
-          items = _yield$getDatasourceD4.items;
-          nextPageCursor = _yield$getDatasourceD4.nextPageCursor;
-          _totalCount = _yield$getDatasourceD4.totalCount;
-          schema = _yield$getDatasourceD4.schema;
-          if (!(access === 'unauthorized')) {
-            _context2.next = 23;
+          _yield$getDatasourceD3 = _context2.sent;
+          _yield$getDatasourceD4 = _yield$getDatasourceD3.meta;
+          access = _yield$getDatasourceD4.access;
+          _destinationObjectTypes = _yield$getDatasourceD4.destinationObjectTypes;
+          _extensionKey = _yield$getDatasourceD4.extensionKey;
+          auth = _yield$getDatasourceD4.auth;
+          _yield$getDatasourceD5 = _yield$getDatasourceD3.data;
+          items = _yield$getDatasourceD5.items;
+          nextPageCursor = _yield$getDatasourceD5.nextPageCursor;
+          _totalCount = _yield$getDatasourceD5.totalCount;
+          schema = _yield$getDatasourceD5.schema;
+          if (!(access === 'unauthorized' || access === 'forbidden')) {
+            _context2.next = 25;
             break;
           }
-          setStatus('unauthorized');
+          setStatus(access);
+          setAuthDetails(auth || initialEmptyArray);
           return _context2.abrupt("return");
-        case 23:
-          if (!(access === 'forbidden')) {
-            _context2.next = 26;
-            break;
-          }
-          setStatus('forbidden');
-          return _context2.abrupt("return");
-        case 26:
+        case 25:
           setExtensionKey(_extensionKey);
           setDestinationObjectTypes(_destinationObjectTypes);
           setTotalCount(_totalCount);
@@ -285,49 +284,52 @@ var useDatasourceTableState = exports.useDatasourceTableState = function useData
             });
           }
           setStatus('resolved');
-          _context2.next = 49;
+          _context2.next = 48;
           break;
-        case 39:
-          _context2.prev = 39;
+        case 38:
+          _context2.prev = 38;
           _context2.t0 = _context2["catch"](7);
           captureError('onNextPage', _context2.t0);
           if (!(_context2.t0 instanceof Response && _context2.t0.status === 401)) {
-            _context2.next = 45;
+            _context2.next = 44;
             break;
           }
           setStatus('unauthorized');
           return _context2.abrupt("return");
-        case 45:
+        case 44:
           if (!(_context2.t0 instanceof Response && _context2.t0.status === 403)) {
-            _context2.next = 48;
+            _context2.next = 47;
             break;
           }
           setStatus('forbidden');
           return _context2.abrupt("return");
-        case 48:
+        case 47:
           setStatus('rejected');
-        case 49:
+        case 48:
         case "end":
           return _context2.stop();
       }
-    }, _callee2, null, [[7, 39]]);
-  })), [captureError, parameters, fieldKeys, nextCursor, getDatasourceData, datasourceId, responseItems, applySchemaProperties, fireEvent, fullSchema]);
+    }, _callee2, null, [[7, 38]]);
+  })), [captureError, parameters, fieldKeys, nextCursor, getDatasourceData, datasourceId, responseItems, applySchemaProperties, fireEvent, fullSchema, initialEmptyArray]);
   var reset = (0, _react.useCallback)(function (options) {
-    setStatus('empty');
-    setResponseItems([]);
+    setResponseItems(initialEmptyArray);
     setHasNextPage(true);
     setNextCursor(undefined);
     setTotalCount(undefined);
-    setLastRequestedFieldKeys([]);
+    setLastRequestedFieldKeys(initialEmptyArray);
+    setAuthDetails(initialEmptyArray);
     setFullSchema({
-      properties: []
+      properties: initialEmptyArray
     });
     setShouldForceRequest((options === null || options === void 0 ? void 0 : options.shouldForceRequest) || false);
     if (options !== null && options !== void 0 && options.shouldResetColumns) {
-      setColumns([]);
-      setDefaultVisibleColumnKeys([]);
+      setColumns(initialEmptyArray);
+      setDefaultVisibleColumnKeys(initialEmptyArray);
     }
-  }, []);
+
+    // setting the status earlier is triggering useEffects without all reset state values, hence placing this as the last state reset item
+    setStatus('empty');
+  }, [initialEmptyArray]);
 
   // this takes care of requesting /data initially
   (0, _react.useEffect)(function () {
@@ -378,6 +380,7 @@ var useDatasourceTableState = exports.useDatasourceTableState = function useData
     defaultVisibleColumnKeys: defaultVisibleColumnKeys,
     totalCount: totalCount,
     extensionKey: extensionKey,
-    destinationObjectTypes: destinationObjectTypes
+    destinationObjectTypes: destinationObjectTypes,
+    authDetails: authDetails
   };
 };

package/dist/cjs/index.js

@@ -47,9 +47,16 @@ Object.defineProperty(exports, "LazyLoadedDatasourceRenderFailedAnalyticsWrapper
     return _renderFailed.LazyLoadedDatasourceRenderFailedAnalyticsWrapper;
   }
 });
+Object.defineProperty(exports, "buildDatasourceAdf", {
+  enumerable: true,
+  get: function get() {
+    return _adf.buildDatasourceAdf;
+  }
+});
 var _jiraIssuesModal = _interopRequireWildcard(require("./ui/jira-issues-modal"));
 var _assetsModal = _interopRequireWildcard(require("./ui/assets-modal"));
 var _datasourceTableView = _interopRequireDefault(require("./ui/datasource-table-view"));
+var _adf = require("./common/utils/adf");
 var _renderFailed = require("./analytics/wrappers/render-failed");
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }

package/dist/cjs/ui/assets-modal/modal/index.js

@@ -23,6 +23,7 @@ var _types = require("../../../analytics/types");
 var _ufoExperiences = require("../../../analytics/ufoExperiences");
 var _useColumnPickerRenderedFailedUfoExperience = require("../../../analytics/ufoExperiences/hooks/useColumnPickerRenderedFailedUfoExperience");
 var _useDataRenderedUfoExperience = require("../../../analytics/ufoExperiences/hooks/useDataRenderedUfoExperience");
+var _adf = require("../../../common/utils/adf");
 var _fetchMessagesForLocale = require("../../../common/utils/locale/fetch-messages-for-locale");
 var _useAssetsClient2 = require("../../../hooks/useAssetsClient");
 var _useDatasourceTableState = require("../../../hooks/useDatasourceTableState");
@@ -251,29 +252,24 @@ var PlainAssetsConfigModal = function PlainAssetsConfigModal(props) {
         }
       }, consumerEvent);
     } else {
-      onInsert({
-        type: 'blockCard',
-        attrs: {
-          datasource: {
-            id: datasourceId,
-            parameters: {
-              workspaceId: workspaceId,
-              aql: aql,
-              schemaId: schemaId
-            },
-            views: [{
-              type: 'table',
-              properties: {
-                columns: visibleColumnKeys === null || visibleColumnKeys === void 0 ? void 0 : visibleColumnKeys.map(function (key) {
-                  return {
-                    key: key
-                  };
-                })
-              }
-            }]
+      onInsert((0, _adf.buildDatasourceAdf)({
+        id: datasourceId,
+        parameters: {
+          workspaceId: workspaceId,
+          aql: aql,
+          schemaId: schemaId
+        },
+        views: [{
+          type: 'table',
+          properties: {
+            columns: (visibleColumnKeys !== null && visibleColumnKeys !== void 0 ? visibleColumnKeys : []).map(function (key) {
+              return {
+                key: key
+              };
+            })
           }
-        }
-      }, consumerEvent);
+        }]
+      }), consumerEvent);
     }
   }, [aql, schemaId, workspaceId, analyticsPayload, totalCount, retrieveUrlForSmartCardRender, responseItems.length, onInsert, datasourceId, visibleColumnKeys]);
   var onCancelClick = (0, _react.useCallback)(function (e, analyticEvent) {

package/dist/cjs/ui/common/error-state/messages.js

@@ -60,5 +60,25 @@ var loadingErrorMessages = exports.loadingErrorMessages = (0, _reactIntlNext.def
     id: 'linkDataSource.jira-issues.no.jira.sites.access.description',
     description: 'Description that shows in the modal when user has no access to any Jira sites',
     defaultMessage: 'To request access, contact your admin.'
+  },
+  authScreenHeaderText: {
+    id: 'linkDataSource.datasource.table.authScreenHeaderText',
+    defaultMessage: 'Connect your account',
+    description: 'Header text to be displayed in the auth screen UI.'
+  },
+  authScreenDescriptionText: {
+    id: 'linkDataSource.datasource.table.authScreenDescriptionText',
+    defaultMessage: 'Connect your account to collaborate on work across Atlassian products.',
+    description: 'Description text to be displayed in the auth screen UI.'
+  },
+  learnMoreAboutSmartLinks: {
+    id: 'linkDataSource.datasource.table.learnMoreAboutSmartLinks',
+    defaultMessage: 'Learn more about Smart Links.',
+    description: 'An anchor link to redirect user to a page about Smart Links.'
+  },
+  authConnectButtonText: {
+    id: 'linkDataSource.datasource.table.authConnectButtonText',
+    defaultMessage: 'Connect',
+    description: 'Label for the authentication button.'
   }
 });