@atlaskit/link-datasource 1.3.1 → 1.4.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/link-datasource
 
+## 1.4.1
+
+### Patch Changes
+
+- [`c8a7c9e33a8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c8a7c9e33a8) - [ux] Fixed columns not updating on reinsertion with new columns
+
+## 1.4.0
+
+### Minor Changes
+
+- [`b2a9540c8d8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b2a9540c8d8) - Export a new DatasourceRenderFailedAnalyticsWrapper - a component that can be consumed to emit 'ui.datasource.renderFailed' events when an inserted datasource fails to render
+
 ## 1.3.1
 
 ### Patch Changes

package/dist/cjs/analytics/constants.js

@@ -8,6 +8,6 @@ var EVENT_CHANNEL = 'media';
 exports.EVENT_CHANNEL = EVENT_CHANNEL;
 var packageMetaData = {
   packageName: "@atlaskit/link-datasource",
-  packageVersion: "1.3.1"
+  packageVersion: "1.4.1"
 };
 exports.packageMetaData = packageMetaData;

package/dist/cjs/analytics/index.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.DatasourceRenderFailedAnalyticsWrapper = void 0;
 Object.defineProperty(exports, "EVENT_CHANNEL", {
   enumerable: true,
   get: function get() {
@@ -10,9 +11,22 @@ Object.defineProperty(exports, "EVENT_CHANNEL", {
   }
 });
 exports.useDatasourceAnalyticsEvents = void 0;
+var _react = require("react");
 var _constants = require("./constants");
+var _analyticsNext = require("@atlaskit/analytics-next");
 var _useAnalyticsEvents = require("./generated/use-analytics-events");
 var useDatasourceAnalyticsEvents = function useDatasourceAnalyticsEvents() {
   return (0, _useAnalyticsEvents.useAnalyticsEvents)();
 };
-exports.useDatasourceAnalyticsEvents = useDatasourceAnalyticsEvents;
+exports.useDatasourceAnalyticsEvents = useDatasourceAnalyticsEvents;
+var DatasourceRenderFailedAnalyticsWrapper = (0, _analyticsNext.withAnalyticsContext)(_constants.packageMetaData)(function (props) {
+  var _useDatasourceAnalyti = useDatasourceAnalyticsEvents(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
+  (0, _react.useEffect)(function () {
+    fireEvent('ui.datasource.renderFailure', {
+      reason: 'internal'
+    });
+  }, [fireEvent]);
+  return props.children;
+});
+exports.DatasourceRenderFailedAnalyticsWrapper = DatasourceRenderFailedAnalyticsWrapper;

package/dist/cjs/hooks/useDatasourceTableState.js

@@ -10,6 +10,7 @@ var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _react = require("react");
+var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 var _linkClientExtension = require("@atlaskit/link-client-extension");
 var _analytics = require("../analytics");
 var useDatasourceTableState = function useDatasourceTableState(_ref) {
@@ -114,7 +115,7 @@ var useDatasourceTableState = function useDatasourceTableState(_ref) {
     }, _callee, null, [[2, 17]]);
   })), [columns, datasourceId, getDatasourceDetails, parameters]);
   var applySchemaProperties = (0, _react.useCallback)(function (properties) {
-    if (columns.length === 0) {
+    if (!(0, _isEqual.default)(columns, properties)) {
       setColumns(properties);
     }
     var defaultProperties = properties.map(function (prop) {
@@ -123,13 +124,13 @@ var useDatasourceTableState = function useDatasourceTableState(_ref) {
 
     // when loading for the first time, we will need to set default visible props as /data does not give you that info
     // also, since we dont pass any fields, we will need to set this info as lastRequestedFieldKeys
-    if (defaultVisibleColumnKeys.length === 0) {
+    if (!(0, _isEqual.default)(defaultVisibleColumnKeys, defaultProperties)) {
       setDefaultVisibleColumnKeys(defaultProperties);
     }
-    if (lastRequestedFieldKeys.length === 0) {
+    if (!(0, _isEqual.default)(lastRequestedFieldKeys, defaultProperties)) {
       setLastRequestedFieldKeys(defaultProperties);
     }
-  }, [columns.length, defaultVisibleColumnKeys.length, lastRequestedFieldKeys === null || lastRequestedFieldKeys === void 0 ? void 0 : lastRequestedFieldKeys.length]);
+  }, [columns, defaultVisibleColumnKeys, lastRequestedFieldKeys]);
   var onNextPage = (0, _react.useCallback)( /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2() {
     var requestInfo,
       _requestInfo$isSchema,

package/dist/cjs/index.js

@@ -17,6 +17,12 @@ Object.defineProperty(exports, "AssetsConfigModal", {
     return _assetsModal.default;
   }
 });
+Object.defineProperty(exports, "DatasourceRenderFailedAnalyticsWrapper", {
+  enumerable: true,
+  get: function get() {
+    return _analytics.DatasourceRenderFailedAnalyticsWrapper;
+  }
+});
 Object.defineProperty(exports, "DatasourceTableView", {
   enumerable: true,
   get: function get() {
@@ -44,5 +50,6 @@ Object.defineProperty(exports, "JiraIssuesConfigModal", {
 var _jiraIssuesModal = _interopRequireWildcard(require("./ui/jira-issues-modal"));
 var _assetsModal = _interopRequireWildcard(require("./ui/assets-modal"));
 var _datasourceTableView = _interopRequireDefault(require("./ui/datasource-table-view"));
+var _analytics = require("./analytics");
 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

@@ -231,7 +231,7 @@ var analyticsContextAttributes = {
 };
 var analyticsContextData = {
   packageName: "@atlaskit/link-datasource",
-  packageVersion: "1.3.1",
+  packageVersion: "1.4.1",
   source: 'datasourceConfigModal'
 };
 var contextData = _objectSpread(_objectSpread({}, analyticsContextData), {}, {

package/dist/es2019/analytics/constants.js

@@ -1,5 +1,5 @@
 export const EVENT_CHANNEL = 'media';
 export const packageMetaData = {
   packageName: "@atlaskit/link-datasource",
-  packageVersion: "1.3.1"
+  packageVersion: "1.4.1"
 };

package/dist/es2019/analytics/index.js

@@ -1,3 +1,17 @@
+import { useEffect } from 'react';
 export { EVENT_CHANNEL } from './constants';
+import { withAnalyticsContext } from '@atlaskit/analytics-next';
+import { packageMetaData } from './constants';
 import { useAnalyticsEvents } from './generated/use-analytics-events';
-export const useDatasourceAnalyticsEvents = () => useAnalyticsEvents();
+export const useDatasourceAnalyticsEvents = () => useAnalyticsEvents();
+export const DatasourceRenderFailedAnalyticsWrapper = withAnalyticsContext(packageMetaData)(props => {
+  const {
+    fireEvent
+  } = useDatasourceAnalyticsEvents();
+  useEffect(() => {
+    fireEvent('ui.datasource.renderFailure', {
+      reason: 'internal'
+    });
+  }, [fireEvent]);
+  return props.children;
+});

package/dist/es2019/hooks/useDatasourceTableState.js

@@ -1,4 +1,5 @@
 import { useCallback, useEffect, useState } from 'react';
+import isEqual from 'lodash/isEqual';
 import { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension } from '@atlaskit/link-client-extension';
 import { useDatasourceAnalyticsEvents } from '../analytics';
 export const useDatasourceTableState = ({
@@ -52,20 +53,20 @@ export const useDatasourceTableState = ({
     }
   }, [columns, datasourceId, getDatasourceDetails, parameters]);
   const applySchemaProperties = useCallback(properties => {
-    if (columns.length === 0) {
+    if (!isEqual(columns, properties)) {
       setColumns(properties);
     }
     const defaultProperties = properties.map(prop => prop.key);
 
     // when loading for the first time, we will need to set default visible props as /data does not give you that info
     // also, since we dont pass any fields, we will need to set this info as lastRequestedFieldKeys
-    if (defaultVisibleColumnKeys.length === 0) {
+    if (!isEqual(defaultVisibleColumnKeys, defaultProperties)) {
       setDefaultVisibleColumnKeys(defaultProperties);
     }
-    if (lastRequestedFieldKeys.length === 0) {
+    if (!isEqual(lastRequestedFieldKeys, defaultProperties)) {
       setLastRequestedFieldKeys(defaultProperties);
     }
-  }, [columns.length, defaultVisibleColumnKeys.length, lastRequestedFieldKeys === null || lastRequestedFieldKeys === void 0 ? void 0 : lastRequestedFieldKeys.length]);
+  }, [columns, defaultVisibleColumnKeys, lastRequestedFieldKeys]);
   const onNextPage = useCallback(async (requestInfo = {}) => {
     if (!parameters) {
       return;

package/dist/es2019/index.js

@@ -3,4 +3,5 @@ export { default as AssetsConfigModal } from './ui/assets-modal';
 export { default as DatasourceTableView } from './ui/datasource-table-view';
 export { default as JSMAssetsConfigModal } from './ui/assets-modal';
 export { JIRA_LIST_OF_LINKS_DATASOURCE_ID } from './ui/jira-issues-modal';
-export { ASSETS_LIST_OF_LINKS_DATASOURCE_ID } from './ui/assets-modal';
+export { ASSETS_LIST_OF_LINKS_DATASOURCE_ID } from './ui/assets-modal';
+export { DatasourceRenderFailedAnalyticsWrapper } from './analytics';

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

@@ -205,7 +205,7 @@ const analyticsContextAttributes = {
 };
 const analyticsContextData = {
   packageName: "@atlaskit/link-datasource",
-  packageVersion: "1.3.1",
+  packageVersion: "1.4.1",
   source: 'datasourceConfigModal'
 };
 const contextData = {

package/dist/esm/analytics/constants.js

@@ -1,5 +1,5 @@
 export var EVENT_CHANNEL = 'media';
 export var packageMetaData = {
   packageName: "@atlaskit/link-datasource",
-  packageVersion: "1.3.1"
+  packageVersion: "1.4.1"
 };

package/dist/esm/analytics/index.js

@@ -1,5 +1,18 @@
+import { useEffect } from 'react';
 export { EVENT_CHANNEL } from './constants';
+import { withAnalyticsContext } from '@atlaskit/analytics-next';
+import { packageMetaData } from './constants';
 import { useAnalyticsEvents } from './generated/use-analytics-events';
 export var useDatasourceAnalyticsEvents = function useDatasourceAnalyticsEvents() {
   return useAnalyticsEvents();
-};
+};
+export var DatasourceRenderFailedAnalyticsWrapper = withAnalyticsContext(packageMetaData)(function (props) {
+  var _useDatasourceAnalyti = useDatasourceAnalyticsEvents(),
+    fireEvent = _useDatasourceAnalyti.fireEvent;
+  useEffect(function () {
+    fireEvent('ui.datasource.renderFailure', {
+      reason: 'internal'
+    });
+  }, [fireEvent]);
+  return props.children;
+});

package/dist/esm/hooks/useDatasourceTableState.js

@@ -3,6 +3,7 @@ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { useCallback, useEffect, useState } from 'react';
+import isEqual from 'lodash/isEqual';
 import { DEFAULT_GET_DATASOURCE_DATA_PAGE_SIZE, useDatasourceClientExtension } from '@atlaskit/link-client-extension';
 import { useDatasourceAnalyticsEvents } from '../analytics';
 export var useDatasourceTableState = function useDatasourceTableState(_ref) {
@@ -107,7 +108,7 @@ export var useDatasourceTableState = function useDatasourceTableState(_ref) {
     }, _callee, null, [[2, 17]]);
   })), [columns, datasourceId, getDatasourceDetails, parameters]);
   var applySchemaProperties = useCallback(function (properties) {
-    if (columns.length === 0) {
+    if (!isEqual(columns, properties)) {
       setColumns(properties);
     }
     var defaultProperties = properties.map(function (prop) {
@@ -116,13 +117,13 @@ export var useDatasourceTableState = function useDatasourceTableState(_ref) {
 
     // when loading for the first time, we will need to set default visible props as /data does not give you that info
     // also, since we dont pass any fields, we will need to set this info as lastRequestedFieldKeys
-    if (defaultVisibleColumnKeys.length === 0) {
+    if (!isEqual(defaultVisibleColumnKeys, defaultProperties)) {
       setDefaultVisibleColumnKeys(defaultProperties);
     }
-    if (lastRequestedFieldKeys.length === 0) {
+    if (!isEqual(lastRequestedFieldKeys, defaultProperties)) {
       setLastRequestedFieldKeys(defaultProperties);
     }
-  }, [columns.length, defaultVisibleColumnKeys.length, lastRequestedFieldKeys === null || lastRequestedFieldKeys === void 0 ? void 0 : lastRequestedFieldKeys.length]);
+  }, [columns, defaultVisibleColumnKeys, lastRequestedFieldKeys]);
   var onNextPage = useCallback( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2() {
     var requestInfo,
       _requestInfo$isSchema,

package/dist/esm/index.js

@@ -3,4 +3,5 @@ export { default as AssetsConfigModal } from './ui/assets-modal';
 export { default as DatasourceTableView } from './ui/datasource-table-view';
 export { default as JSMAssetsConfigModal } from './ui/assets-modal';
 export { JIRA_LIST_OF_LINKS_DATASOURCE_ID } from './ui/jira-issues-modal';
-export { ASSETS_LIST_OF_LINKS_DATASOURCE_ID } from './ui/assets-modal';
+export { ASSETS_LIST_OF_LINKS_DATASOURCE_ID } from './ui/assets-modal';
+export { DatasourceRenderFailedAnalyticsWrapper } from './analytics';

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

@@ -222,7 +222,7 @@ var analyticsContextAttributes = {
 };
 var analyticsContextData = {
   packageName: "@atlaskit/link-datasource",
-  packageVersion: "1.3.1",
+  packageVersion: "1.4.1",
   source: 'datasourceConfigModal'
 };
 var contextData = _objectSpread(_objectSpread({}, analyticsContextData), {}, {

package/dist/types/analytics/generated/analytics.types.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::0262ba66242472aeffce99eacc538f23>>
+ * @codegen <<SignedSource::05b7b33172b55f75035f0d77317a3f4f>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
  */
 export type PackageMetaDataType = {
@@ -57,6 +57,7 @@ export type DatasourceRenderSuccessAttributesType = {
     extensionKey: string | null;
     display: 'table';
 };
+export type DatasourceRenderFailureAttributesType = {};
 export type NextItemLoadedAttributesType = {
     destinationObjectTypes: unknown[];
     extensionKey: string | null;
@@ -114,6 +115,9 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when an inserted datasource resolves / renders. */
     'ui.datasource.renderSuccess': DatasourceRenderSuccessAttributesType;
+    /**
+     * Fired when an inserted datasource fails to render */
+    'ui.datasource.renderFailure': DatasourceRenderFailureAttributesType;
     /**
      * Fired when user scrolls to the next page/list of the objects */
     'track.nextItem.loaded': NextItemLoadedAttributesType;

package/dist/types/analytics/index.d.ts

@@ -1,4 +1,6 @@
+/// <reference types="react" />
 export { EVENT_CHANNEL } from './constants';
 export declare const useDatasourceAnalyticsEvents: () => {
     fireEvent: <K extends keyof import("./generated/analytics.types").AnalyticsEventAttributes>(params_0: K, ...params_1: undefined extends import("./generated/analytics.types").AnalyticsEventAttributes[K] ? [param?: import("./generated/analytics.types").AnalyticsEventAttributes[K] | undefined] : [param: import("./generated/analytics.types").AnalyticsEventAttributes[K]]) => void;
 };
+export declare const DatasourceRenderFailedAnalyticsWrapper: import("react").ForwardRefExoticComponent<Pick<any, string | number | symbol> & import("react").RefAttributes<any>>;

package/dist/types/index.d.ts

@@ -7,3 +7,4 @@ export type { AssetsDatasourceAdf, AssetsDatasourceParameters, } from './ui/asse
 export { JIRA_LIST_OF_LINKS_DATASOURCE_ID } from './ui/jira-issues-modal';
 export { ASSETS_LIST_OF_LINKS_DATASOURCE_ID } from './ui/assets-modal';
 export type { DatasourceAdf, DatasourceAdfView, DatasourceAdfTableView, } from '@atlaskit/linking-common/types';
+export { DatasourceRenderFailedAnalyticsWrapper } from './analytics';

package/dist/types-ts4.5/analytics/generated/analytics.types.d.ts

@@ -3,7 +3,7 @@
  *
  * Generates Typescript types for analytics events from analytics.spec.yaml
  *
- * @codegen <<SignedSource::0262ba66242472aeffce99eacc538f23>>
+ * @codegen <<SignedSource::05b7b33172b55f75035f0d77317a3f4f>>
  * @codegenCommand yarn workspace @atlassian/analytics-tooling run analytics:codegen link-datasource
  */
 export type PackageMetaDataType = {
@@ -57,6 +57,7 @@ export type DatasourceRenderSuccessAttributesType = {
     extensionKey: string | null;
     display: 'table';
 };
+export type DatasourceRenderFailureAttributesType = {};
 export type NextItemLoadedAttributesType = {
     destinationObjectTypes: unknown[];
     extensionKey: string | null;
@@ -114,6 +115,9 @@ export type AnalyticsEventAttributes = {
     /**
      * Fired when an inserted datasource resolves / renders. */
     'ui.datasource.renderSuccess': DatasourceRenderSuccessAttributesType;
+    /**
+     * Fired when an inserted datasource fails to render */
+    'ui.datasource.renderFailure': DatasourceRenderFailureAttributesType;
     /**
      * Fired when user scrolls to the next page/list of the objects */
     'track.nextItem.loaded': NextItemLoadedAttributesType;

package/dist/types-ts4.5/analytics/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 export { EVENT_CHANNEL } from './constants';
 export declare const useDatasourceAnalyticsEvents: () => {
     fireEvent: <K extends keyof import("./generated/analytics.types").AnalyticsEventAttributes>(params_0: K, ...params_1: undefined extends import("./generated/analytics.types").AnalyticsEventAttributes[K] ? [
@@ -6,3 +7,4 @@ export declare const useDatasourceAnalyticsEvents: () => {
         param: import("./generated/analytics.types").AnalyticsEventAttributes[K]
     ]) => void;
 };
+export declare const DatasourceRenderFailedAnalyticsWrapper: import("react").ForwardRefExoticComponent<Pick<any, string | number | symbol> & import("react").RefAttributes<any>>;

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

@@ -7,3 +7,4 @@ export type { AssetsDatasourceAdf, AssetsDatasourceParameters, } from './ui/asse
 export { JIRA_LIST_OF_LINKS_DATASOURCE_ID } from './ui/jira-issues-modal';
 export { ASSETS_LIST_OF_LINKS_DATASOURCE_ID } from './ui/assets-modal';
 export type { DatasourceAdf, DatasourceAdfView, DatasourceAdfTableView, } from '@atlaskit/linking-common/types';
+export { DatasourceRenderFailedAnalyticsWrapper } from './analytics';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/link-datasource",
-  "version": "1.3.1",
+  "version": "1.4.1",
   "description": "UI Components to support linking platform dataset feature",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -67,6 +67,7 @@
     "@emotion/react": "^11.7.1",
     "@emotion/styled": "^11.0.0",
     "debounce-promise": "^3.1.2",
+    "lodash": "^4.17.21",
     "react-dom": "^16.8.0",
     "tiny-invariant": "^1.2.0",
     "uuid": "^3.1.0"

package/report.api.md

@@ -20,7 +20,9 @@
 import { DatasourceAdf } from '@atlaskit/linking-common/types';
 import { DatasourceAdfTableView } from '@atlaskit/linking-common/types';
 import { DatasourceAdfView } from '@atlaskit/linking-common/types';
+import { ForwardRefExoticComponent } from 'react';
 import { InlineCardAdf } from '@atlaskit/linking-common/types';
+import { RefAttributes } from 'react';
 import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 
 // @public (undocumented)
@@ -77,6 +79,11 @@ export { DatasourceAdfTableView };
 
 export { DatasourceAdfView };
 
+// @public (undocumented)
+export const DatasourceRenderFailedAnalyticsWrapper: ForwardRefExoticComponent<
+  Pick<any, number | string | symbol> & RefAttributes<any>
+>;
+
 // @public (undocumented)
 export const DatasourceTableView: (
   props: DatasourceTableViewProps,

package/tmp/api-report-tmp.d.ts

@@ -9,7 +9,9 @@
 import { DatasourceAdf } from '@atlaskit/linking-common/types';
 import { DatasourceAdfTableView } from '@atlaskit/linking-common/types';
 import { DatasourceAdfView } from '@atlaskit/linking-common/types';
+import { ForwardRefExoticComponent } from 'react';
 import { InlineCardAdf } from '@atlaskit/linking-common/types';
+import { RefAttributes } from 'react';
 import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
 
 // @public (undocumented)
@@ -63,6 +65,9 @@ export { DatasourceAdfTableView }
 
 export { DatasourceAdfView }
 
+// @public (undocumented)
+export const DatasourceRenderFailedAnalyticsWrapper: ForwardRefExoticComponent<Pick<any, number | string | symbol> & RefAttributes<any>>;
+
 // @public (undocumented)
 export const DatasourceTableView: (props: DatasourceTableViewProps) => JSX.Element;