@atlaskit/dynamic-table 14.20.3 → 15.0.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/dynamic-table
 
+## 15.0.0
+
+### Major Changes
+
+- [#137785](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/137785)
+  [`5fee01201ba15`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/5fee01201ba15) -
+  Removes usage of legacy analytics-next APIs internally in favor of the new APIs which do not
+  depend on legacy react context. This should not require any changes to consumers of the package,
+  however behaviors of the new APIs may result in different behavior in some cases.
+
 ## 14.20.3
 
 ### Patch Changes

package/dist/cjs/components/stateless.js

@@ -5,7 +5,7 @@ var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.DynamicTableWithoutAnalytics = void 0;
+exports.default = void 0;
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
@@ -25,8 +25,6 @@ var _tableHead = _interopRequireDefault(require("./table-head"));
 var _excluded = ["isRankable", "isRanking", "onRankStart", "onRankEnd", "isRankingDisabled"];
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
-var packageName = "@atlaskit/dynamic-table";
-var packageVersion = "14.20.3";
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {
     case _constants.DESC:
@@ -37,7 +35,7 @@ function toggleSortOrder(currentSortOrder) {
       return currentSortOrder;
   }
 }
-var DynamicTable = exports.DynamicTableWithoutAnalytics = function DynamicTable(_ref) {
+var DynamicTable = function DynamicTable(_ref) {
   var caption = _ref.caption,
     head = _ref.head,
     highlightedRowIndex = _ref.highlightedRowIndex,
@@ -58,7 +56,7 @@ var DynamicTable = exports.DynamicTableWithoutAnalytics = function DynamicTable(
     _ref$onSetPage = _ref.onSetPage,
     onSetPage = _ref$onSetPage === void 0 ? _noop.default : _ref$onSetPage,
     _ref$onSort = _ref.onSort,
-    onSort = _ref$onSort === void 0 ? _noop.default : _ref$onSort,
+    providedOnSort = _ref$onSort === void 0 ? _noop.default : _ref$onSort,
     _ref$page = _ref.page,
     page = _ref$page === void 0 ? 1 : _ref$page,
     emptyView = _ref.emptyView,
@@ -69,7 +67,7 @@ var DynamicTable = exports.DynamicTableWithoutAnalytics = function DynamicTable(
     _ref$onRankStart = _ref.onRankStart,
     onRankStart = _ref$onRankStart === void 0 ? _noop.default : _ref$onRankStart,
     _ref$onRankEnd = _ref.onRankEnd,
-    onRankEnd = _ref$onRankEnd === void 0 ? _noop.default : _ref$onRankEnd,
+    providedOnRankEnd = _ref$onRankEnd === void 0 ? _noop.default : _ref$onRankEnd,
     loadingSpinnerSize = _ref.loadingSpinnerSize,
     _ref$paginationi18n = _ref.paginationi18n,
     paginationi18n = _ref$paginationi18n === void 0 ? {
@@ -83,6 +81,20 @@ var DynamicTable = exports.DynamicTableWithoutAnalytics = function DynamicTable(
     isRanking = _useState2[0],
     setIsRanking = _useState2[1];
   var tableBodyRef = (0, _react.useRef)(null);
+  var onSort = (0, _analyticsNext.usePlatformLeafEventHandler)({
+    fn: providedOnSort,
+    action: 'sorted',
+    componentName: 'dynamicTable',
+    packageName: "@atlaskit/dynamic-table",
+    packageVersion: "15.0.0"
+  });
+  var onRankEnd = (0, _analyticsNext.usePlatformLeafEventHandler)({
+    fn: providedOnRankEnd,
+    action: 'ranked',
+    componentName: 'dynamicTable',
+    packageName: "@atlaskit/dynamic-table",
+    packageVersion: "15.0.0"
+  });
   (0, _react.useEffect)(function () {
     (0, _helpers.validateSortKey)(sortKey, head);
     (0, _helpers.assertIsSortable)(head);
@@ -264,38 +276,6 @@ var TableBody = /*#__PURE__*/(0, _react.forwardRef)(function TableBody(_ref2, re
     isRankingDisabled: isRankingDisabled
   })))) : nonRankableBody;
 });
-var createAndFireEventOnAtlaskit = (0, _analyticsNext.createAndFireEvent)('atlaskit');
 
-/**
- * __Dynamic table stateless__
- *
- * A stateless table that requires consumers to manage the sorting, drag and drop, and pagination.
- *
- * - [Examples](https://atlaskit.atlassian.com/packages/design-system/dynamic-table)
- * - [Code](https://bitbucket.org/atlassian/atlassian-frontend/packages/design-system/dynamic-table)
- */
-var DynamicTableStateless = (0, _analyticsNext.withAnalyticsContext)({
-  componentName: 'dynamicTable',
-  packageName: packageName,
-  packageVersion: packageVersion
-})((0, _analyticsNext.withAnalyticsEvents)({
-  onSort: createAndFireEventOnAtlaskit({
-    action: 'sorted',
-    actionSubject: 'dynamicTable',
-    attributes: {
-      componentName: 'dynamicTable',
-      packageName: packageName,
-      packageVersion: packageVersion
-    }
-  }),
-  onRankEnd: createAndFireEventOnAtlaskit({
-    action: 'ranked',
-    actionSubject: 'dynamicTable',
-    attributes: {
-      componentName: 'dynamicTable',
-      packageName: packageName,
-      packageVersion: packageVersion
-    }
-  })
-})(DynamicTable));
-var _default = exports.default = DynamicTableStateless;
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+var _default = exports.default = DynamicTable;

package/dist/es2019/components/stateless.js

@@ -1,6 +1,6 @@
 import _extends from "@babel/runtime/helpers/extends";
 import React, { forwardRef, lazy, Suspense, useEffect, useRef, useState } from 'react';
-import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@atlaskit/analytics-next';
+import { usePlatformLeafEventHandler } from '@atlaskit/analytics-next';
 import noop from '@atlaskit/ds-lib/noop';
 import { ASC, DESC, LARGE, SMALL } from '../internal/constants';
 import { assertIsSortable, getPageRows, validateSortKey } from '../internal/helpers';
@@ -12,8 +12,6 @@ import LoadingContainer from './loading-container';
 import LoadingContainerAdvanced from './loading-container-advanced';
 import ManagedPagination from './managed-pagination';
 import TableHead from './table-head';
-const packageName = "@atlaskit/dynamic-table";
-const packageVersion = "14.20.3";
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {
     case DESC:
@@ -40,13 +38,13 @@ const DynamicTable = ({
   isFixedSize = false,
   rowsPerPage = Infinity,
   onSetPage = noop,
-  onSort = noop,
+  onSort: providedOnSort = noop,
   page = 1,
   emptyView,
   isRankable = false,
   isRankingDisabled = false,
   onRankStart = noop,
-  onRankEnd = noop,
+  onRankEnd: providedOnRankEnd = noop,
   loadingSpinnerSize,
   paginationi18n = {
     prev: 'Previous',
@@ -57,6 +55,20 @@ const DynamicTable = ({
 }) => {
   const [isRanking, setIsRanking] = useState(false);
   const tableBodyRef = useRef(null);
+  const onSort = usePlatformLeafEventHandler({
+    fn: providedOnSort,
+    action: 'sorted',
+    componentName: 'dynamicTable',
+    packageName: "@atlaskit/dynamic-table",
+    packageVersion: "15.0.0"
+  });
+  const onRankEnd = usePlatformLeafEventHandler({
+    fn: providedOnRankEnd,
+    action: 'ranked',
+    componentName: 'dynamicTable',
+    packageName: "@atlaskit/dynamic-table",
+    packageVersion: "15.0.0"
+  });
   useEffect(() => {
     validateSortKey(sortKey, head);
     assertIsSortable(head);
@@ -229,39 +241,6 @@ const TableBody = /*#__PURE__*/forwardRef(function TableBody({
     isRankingDisabled: isRankingDisabled
   })))) : nonRankableBody;
 });
-export { DynamicTable as DynamicTableWithoutAnalytics };
-const createAndFireEventOnAtlaskit = createAndFireEvent('atlaskit');
 
-/**
- * __Dynamic table stateless__
- *
- * A stateless table that requires consumers to manage the sorting, drag and drop, and pagination.
- *
- * - [Examples](https://atlaskit.atlassian.com/packages/design-system/dynamic-table)
- * - [Code](https://bitbucket.org/atlassian/atlassian-frontend/packages/design-system/dynamic-table)
- */
-const DynamicTableStateless = withAnalyticsContext({
-  componentName: 'dynamicTable',
-  packageName,
-  packageVersion
-})(withAnalyticsEvents({
-  onSort: createAndFireEventOnAtlaskit({
-    action: 'sorted',
-    actionSubject: 'dynamicTable',
-    attributes: {
-      componentName: 'dynamicTable',
-      packageName,
-      packageVersion
-    }
-  }),
-  onRankEnd: createAndFireEventOnAtlaskit({
-    action: 'ranked',
-    actionSubject: 'dynamicTable',
-    attributes: {
-      componentName: 'dynamicTable',
-      packageName,
-      packageVersion
-    }
-  })
-})(DynamicTable));
-export default DynamicTableStateless;
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+export default DynamicTable;

package/dist/esm/components/stateless.js

@@ -3,7 +3,7 @@ import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProper
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 var _excluded = ["isRankable", "isRanking", "onRankStart", "onRankEnd", "isRankingDisabled"];
 import React, { forwardRef, lazy, Suspense, useEffect, useRef, useState } from 'react';
-import { createAndFireEvent, withAnalyticsContext, withAnalyticsEvents } from '@atlaskit/analytics-next';
+import { usePlatformLeafEventHandler } from '@atlaskit/analytics-next';
 import noop from '@atlaskit/ds-lib/noop';
 import { ASC, DESC, LARGE, SMALL } from '../internal/constants';
 import { assertIsSortable, getPageRows, validateSortKey } from '../internal/helpers';
@@ -15,8 +15,6 @@ import LoadingContainer from './loading-container';
 import LoadingContainerAdvanced from './loading-container-advanced';
 import ManagedPagination from './managed-pagination';
 import TableHead from './table-head';
-var packageName = "@atlaskit/dynamic-table";
-var packageVersion = "14.20.3";
 function toggleSortOrder(currentSortOrder) {
   switch (currentSortOrder) {
     case DESC:
@@ -48,7 +46,7 @@ var DynamicTable = function DynamicTable(_ref) {
     _ref$onSetPage = _ref.onSetPage,
     onSetPage = _ref$onSetPage === void 0 ? noop : _ref$onSetPage,
     _ref$onSort = _ref.onSort,
-    onSort = _ref$onSort === void 0 ? noop : _ref$onSort,
+    providedOnSort = _ref$onSort === void 0 ? noop : _ref$onSort,
     _ref$page = _ref.page,
     page = _ref$page === void 0 ? 1 : _ref$page,
     emptyView = _ref.emptyView,
@@ -59,7 +57,7 @@ var DynamicTable = function DynamicTable(_ref) {
     _ref$onRankStart = _ref.onRankStart,
     onRankStart = _ref$onRankStart === void 0 ? noop : _ref$onRankStart,
     _ref$onRankEnd = _ref.onRankEnd,
-    onRankEnd = _ref$onRankEnd === void 0 ? noop : _ref$onRankEnd,
+    providedOnRankEnd = _ref$onRankEnd === void 0 ? noop : _ref$onRankEnd,
     loadingSpinnerSize = _ref.loadingSpinnerSize,
     _ref$paginationi18n = _ref.paginationi18n,
     paginationi18n = _ref$paginationi18n === void 0 ? {
@@ -73,6 +71,20 @@ var DynamicTable = function DynamicTable(_ref) {
     isRanking = _useState2[0],
     setIsRanking = _useState2[1];
   var tableBodyRef = useRef(null);
+  var onSort = usePlatformLeafEventHandler({
+    fn: providedOnSort,
+    action: 'sorted',
+    componentName: 'dynamicTable',
+    packageName: "@atlaskit/dynamic-table",
+    packageVersion: "15.0.0"
+  });
+  var onRankEnd = usePlatformLeafEventHandler({
+    fn: providedOnRankEnd,
+    action: 'ranked',
+    componentName: 'dynamicTable',
+    packageName: "@atlaskit/dynamic-table",
+    packageVersion: "15.0.0"
+  });
   useEffect(function () {
     validateSortKey(sortKey, head);
     assertIsSortable(head);
@@ -252,39 +264,6 @@ var TableBody = /*#__PURE__*/forwardRef(function TableBody(_ref2, ref) {
     isRankingDisabled: isRankingDisabled
   })))) : nonRankableBody;
 });
-export { DynamicTable as DynamicTableWithoutAnalytics };
-var createAndFireEventOnAtlaskit = createAndFireEvent('atlaskit');
 
-/**
- * __Dynamic table stateless__
- *
- * A stateless table that requires consumers to manage the sorting, drag and drop, and pagination.
- *
- * - [Examples](https://atlaskit.atlassian.com/packages/design-system/dynamic-table)
- * - [Code](https://bitbucket.org/atlassian/atlassian-frontend/packages/design-system/dynamic-table)
- */
-var DynamicTableStateless = withAnalyticsContext({
-  componentName: 'dynamicTable',
-  packageName: packageName,
-  packageVersion: packageVersion
-})(withAnalyticsEvents({
-  onSort: createAndFireEventOnAtlaskit({
-    action: 'sorted',
-    actionSubject: 'dynamicTable',
-    attributes: {
-      componentName: 'dynamicTable',
-      packageName: packageName,
-      packageVersion: packageVersion
-    }
-  }),
-  onRankEnd: createAndFireEventOnAtlaskit({
-    action: 'ranked',
-    actionSubject: 'dynamicTable',
-    attributes: {
-      componentName: 'dynamicTable',
-      packageName: packageName,
-      packageVersion: packageVersion
-    }
-  })
-})(DynamicTable));
-export default DynamicTableStateless;
+// eslint-disable-next-line @repo/internal/react/require-jsdoc
+export default DynamicTable;

package/dist/types/components/stateless.d.ts

@@ -1,14 +1,4 @@
-import React from 'react';
+/// <reference types="react" />
 import { type StatelessProps as Props } from '../types';
-declare const DynamicTable: ({ caption, head, highlightedRowIndex, rows, sortKey, sortOrder, loadingLabel, onPageRowsUpdate, testId, totalRows: passedDownTotalRows, label, isLoading, isFixedSize, rowsPerPage, onSetPage, onSort, page, emptyView, isRankable, isRankingDisabled, onRankStart, onRankEnd, loadingSpinnerSize, paginationi18n, }: Props) => JSX.Element;
-export { DynamicTable as DynamicTableWithoutAnalytics };
-/**
- * __Dynamic table stateless__
- *
- * A stateless table that requires consumers to manage the sorting, drag and drop, and pagination.
- *
- * - [Examples](https://atlaskit.atlassian.com/packages/design-system/dynamic-table)
- * - [Code](https://bitbucket.org/atlassian/atlassian-frontend/packages/design-system/dynamic-table)
- */
-declare const DynamicTableStateless: React.ForwardRefExoticComponent<Pick<Omit<Props, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "head" | "caption" | "rows" | "emptyView" | "loadingSpinnerSize" | "isLoading" | "loadingLabel" | "isFixedSize" | "rowsPerPage" | "totalRows" | "onSetPage" | "onSort" | "onPageRowsUpdate" | "page" | "sortKey" | "sortOrder" | "isRankable" | "isRankingDisabled" | "onRankStart" | "onRankEnd" | "paginationi18n" | "highlightedRowIndex" | "testId" | "label" | "key" | "analyticsContext"> & React.RefAttributes<any>>;
-export default DynamicTableStateless;
+declare const DynamicTable: ({ caption, head, highlightedRowIndex, rows, sortKey, sortOrder, loadingLabel, onPageRowsUpdate, testId, totalRows: passedDownTotalRows, label, isLoading, isFixedSize, rowsPerPage, onSetPage, onSort: providedOnSort, page, emptyView, isRankable, isRankingDisabled, onRankStart, onRankEnd: providedOnRankEnd, loadingSpinnerSize, paginationi18n, }: Props) => JSX.Element;
+export default DynamicTable;

package/dist/types-ts4.5/components/stateless.d.ts

@@ -1,14 +1,4 @@
-import React from 'react';
+/// <reference types="react" />
 import { type StatelessProps as Props } from '../types';
-declare const DynamicTable: ({ caption, head, highlightedRowIndex, rows, sortKey, sortOrder, loadingLabel, onPageRowsUpdate, testId, totalRows: passedDownTotalRows, label, isLoading, isFixedSize, rowsPerPage, onSetPage, onSort, page, emptyView, isRankable, isRankingDisabled, onRankStart, onRankEnd, loadingSpinnerSize, paginationi18n, }: Props) => JSX.Element;
-export { DynamicTable as DynamicTableWithoutAnalytics };
-/**
- * __Dynamic table stateless__
- *
- * A stateless table that requires consumers to manage the sorting, drag and drop, and pagination.
- *
- * - [Examples](https://atlaskit.atlassian.com/packages/design-system/dynamic-table)
- * - [Code](https://bitbucket.org/atlassian/atlassian-frontend/packages/design-system/dynamic-table)
- */
-declare const DynamicTableStateless: React.ForwardRefExoticComponent<Pick<Omit<Props, keyof import("@atlaskit/analytics-next").WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "head" | "caption" | "rows" | "emptyView" | "loadingSpinnerSize" | "isLoading" | "loadingLabel" | "isFixedSize" | "rowsPerPage" | "totalRows" | "onSetPage" | "onSort" | "onPageRowsUpdate" | "page" | "sortKey" | "sortOrder" | "isRankable" | "isRankingDisabled" | "onRankStart" | "onRankEnd" | "paginationi18n" | "highlightedRowIndex" | "testId" | "label" | "key" | "analyticsContext"> & React.RefAttributes<any>>;
-export default DynamicTableStateless;
+declare const DynamicTable: ({ caption, head, highlightedRowIndex, rows, sortKey, sortOrder, loadingLabel, onPageRowsUpdate, testId, totalRows: passedDownTotalRows, label, isLoading, isFixedSize, rowsPerPage, onSetPage, onSort: providedOnSort, page, emptyView, isRankable, isRankingDisabled, onRankStart, onRankEnd: providedOnRankEnd, loadingSpinnerSize, paginationi18n, }: Props) => JSX.Element;
+export default DynamicTable;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/dynamic-table",
-	"version": "14.20.3",
+	"version": "15.0.0",
 	"description": "A dynamic table displays rows of data with built-in pagination, sorting, and re-ordering functionality.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -56,7 +56,7 @@
 		"@af/integration-testing": "*",
 		"@af/visual-regression": "*",
 		"@atlaskit/ssr": "*",
-		"@atlaskit/toggle": "^13.3.0",
+		"@atlaskit/toggle": "^13.4.0",
 		"@atlaskit/visual-regression": "*",
 		"@emotion/styled": "^11.0.0",
 		"@testing-library/react": "^12.1.5",