fix(material/legacy-table): deprecate all ts symbols

mmalerba · mmalerba · commit 30f88b0853aa · 2022-09-07T11:39:08.000-07:00
diff --git a/src/material/legacy-table/cell.ts b/src/material/legacy-table/cell.ts
@@ -20,6 +20,8 @@ import {
 /**
  * Cell definition for the mat-table.
  * Captures the template of a column's data row cell as well as cell-specific properties.
+ * @deprecated Use `MatCellDef` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Directive({
   selector: '[matCellDef]',
@@ -30,6 +32,8 @@ export class MatLegacyCellDef extends CdkCellDef {}
 /**
  * Header cell definition for the mat-table.
  * Captures the template of a column's header cell and as well as cell-specific properties.
+ * @deprecated Use `MatHeaderCellDef` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Directive({
   selector: '[matHeaderCellDef]',
@@ -40,6 +44,8 @@ export class MatLegacyHeaderCellDef extends CdkHeaderCellDef {}
 /**
  * Footer cell definition for the mat-table.
  * Captures the template of a column's footer cell and as well as cell-specific properties.
+ * @deprecated Use `MatFooterCellDef` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Directive({
   selector: '[matFooterCellDef]',
@@ -50,6 +56,8 @@ export class MatLegacyFooterCellDef extends CdkFooterCellDef {}
 /**
  * Column definition for the mat-table.
  * Defines a set of cells available for a table column.
+ * @deprecated Use `MatColumnDef` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Directive({
   selector: '[matColumnDef]',
@@ -81,7 +89,11 @@ export class MatLegacyColumnDef extends CdkColumnDef {
   }
 }
 
-/** Header cell template container that adds the right classes and role. */
+/**
+ * Header cell template container that adds the right classes and role.
+ * @deprecated Use `MatHeaderCell` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @Directive({
   selector: 'mat-header-cell, th[mat-header-cell]',
   host: {
@@ -91,7 +103,11 @@ export class MatLegacyColumnDef extends CdkColumnDef {
 })
 export class MatLegacyHeaderCell extends CdkHeaderCell {}
 
-/** Footer cell template container that adds the right classes and role. */
+/**
+ * Footer cell template container that adds the right classes and role.
+ * @deprecated Use `MatFooterCell` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @Directive({
   selector: 'mat-footer-cell, td[mat-footer-cell]',
   host: {
@@ -101,7 +117,11 @@ export class MatLegacyHeaderCell extends CdkHeaderCell {}
 })
 export class MatLegacyFooterCell extends CdkFooterCell {}
 
-/** Cell template container that adds the right classes and role. */
+/**
+ * Cell template container that adds the right classes and role.
+ * @deprecated Use `MatCell` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @Directive({
   selector: 'mat-cell, td[mat-cell]',
   host: {
diff --git a/src/material/legacy-table/public-api.ts b/src/material/legacy-table/public-api.ts
@@ -29,7 +29,21 @@ export {
 export {MatLegacyTableDataSource} from './table-data-source';
 export {MatLegacyTextColumn} from './text-column';
 export {
+  /**
+   * @deprecated Use `MatTableDataSourcePageEvent` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MatTableDataSourcePageEvent as MatLegacyTableDataSourcePageEvent,
+
+  /**
+   * @deprecated Use `MatTableDataSourcePaginator` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MatTableDataSourcePaginator as MatLegacyTableDataSourcePaginator,
+
+  /**
+   * @deprecated Use `_MatTableDataSource` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   _MatTableDataSource as _MatLegacyTableDataSource,
 } from '@angular/material/table';
diff --git a/src/material/legacy-table/row.ts b/src/material/legacy-table/row.ts
@@ -21,6 +21,8 @@ import {ChangeDetectionStrategy, Component, Directive, ViewEncapsulation} from '
 /**
  * Header row definition for the mat-table.
  * Captures the header row's template and other header properties such as the columns to display.
+ * @deprecated Use `MatHeaderRowDef` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Directive({
   selector: '[matHeaderRowDef]',
@@ -32,6 +34,8 @@ export class MatLegacyHeaderRowDef extends CdkHeaderRowDef {}
 /**
  * Footer row definition for the mat-table.
  * Captures the footer row's template and other footer properties such as the columns to display.
+ * @deprecated Use `MatFooterRowDef` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Directive({
   selector: '[matFooterRowDef]',
@@ -44,6 +48,8 @@ export class MatLegacyFooterRowDef extends CdkFooterRowDef {}
  * Data row definition for the mat-table.
  * Captures the data row's template and other properties such as the columns to display and
  * a when predicate that describes when this row should be used.
+ * @deprecated Use `MatRowDef` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Directive({
   selector: '[matRowDef]',
@@ -52,7 +58,11 @@ export class MatLegacyFooterRowDef extends CdkFooterRowDef {}
 })
 export class MatLegacyRowDef<T> extends CdkRowDef<T> {}
 
-/** Header template container that contains the cell outlet. Adds the right class and role. */
+/**
+ * Header template container that contains the cell outlet. Adds the right class and role.
+ * @deprecated Use `MatHeaderRow` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @Component({
   selector: 'mat-header-row, tr[mat-header-row]',
   template: CDK_ROW_TEMPLATE,
@@ -69,7 +79,11 @@ export class MatLegacyRowDef<T> extends CdkRowDef<T> {}
 })
 export class MatLegacyHeaderRow extends CdkHeaderRow {}
 
-/** Footer template container that contains the cell outlet. Adds the right class and role. */
+/**
+ * Footer template container that contains the cell outlet. Adds the right class and role.
+ * @deprecated Use `MatFooterRow` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @Component({
   selector: 'mat-footer-row, tr[mat-footer-row]',
   template: CDK_ROW_TEMPLATE,
@@ -86,7 +100,11 @@ export class MatLegacyHeaderRow extends CdkHeaderRow {}
 })
 export class MatLegacyFooterRow extends CdkFooterRow {}
 
-/** Data row template container that contains the cell outlet. Adds the right class and role. */
+/**
+ * Data row template container that contains the cell outlet. Adds the right class and role.
+ * @deprecated Use `MatRow` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @Component({
   selector: 'mat-row, tr[mat-row]',
   template: CDK_ROW_TEMPLATE,
@@ -103,7 +121,11 @@ export class MatLegacyFooterRow extends CdkFooterRow {}
 })
 export class MatLegacyRow extends CdkRow {}
 
-/** Row that can be used to display a message when no data is shown in the table. */
+/**
+ * Row that can be used to display a message when no data is shown in the table.
+ * @deprecated Use `MatNoDataRow` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @Directive({
   selector: 'ng-template[matNoDataRow]',
   providers: [{provide: CdkNoDataRow, useExisting: MatLegacyNoDataRow}],
diff --git a/src/material/legacy-table/table-data-source.ts b/src/material/legacy-table/table-data-source.ts
@@ -21,5 +21,8 @@ import {_MatTableDataSource} from '@angular/material/table';
  * it isn't equipped to handle some more advanced cases like robust i18n support or server-side
  * interactions. If your app needs to support more advanced use cases, consider implementing your
  * own `DataSource`.
+ *
+ * @deprecated Use `MatTableDataSource` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 export class MatLegacyTableDataSource<T> extends _MatTableDataSource<T, MatLegacyPaginator> {}
diff --git a/src/material/legacy-table/table-module.ts b/src/material/legacy-table/table-module.ts
@@ -58,6 +58,10 @@ const EXPORTED_DECLARATIONS = [
   MatLegacyTextColumn,
 ];
 
+/**
+ * @deprecated Use `MatTableModule` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 @NgModule({
   imports: [CdkTableModule, MatCommonModule],
   exports: [MatCommonModule, EXPORTED_DECLARATIONS],
diff --git a/src/material/legacy-table/table.ts b/src/material/legacy-table/table.ts
@@ -24,6 +24,8 @@ import {
 /**
  * Enables the recycle view repeater strategy, which reduces rendering latency. Not compatible with
  * tables that animate rows.
+ * @deprecated Use `MatRecycleRows` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Directive({
   selector: 'mat-table[recycleRows], table[mat-table][recycleRows]',
@@ -33,6 +35,8 @@ export class MatLegacyRecycleRows {}
 
 /**
  * Wrapper for the CdkTable with Material design styles.
+ * @deprecated Use `MatTable` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Component({
   selector: 'mat-table, table[mat-table]',
diff --git a/src/material/legacy-table/testing/cell-harness.ts b/src/material/legacy-table/testing/cell-harness.ts
@@ -9,7 +9,11 @@
 import {HarnessPredicate} from '@angular/cdk/testing';
 import {_MatCellHarnessBase, CellHarnessFilters} from '@angular/material/table/testing';
 
-/** Harness for interacting with a standard Angular Material table cell. */
+/**
+ * Harness for interacting with a standard Angular Material table cell.
+ * @deprecated Use `MatCellHarness` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 export class MatLegacyCellHarness extends _MatCellHarnessBase {
   /** The selector for the host element of a `MatCellHarness` instance. */
   static hostSelector = '.mat-cell';
@@ -24,7 +28,11 @@ export class MatLegacyCellHarness extends _MatCellHarnessBase {
   }
 }
 
-/** Harness for interacting with a standard Angular Material table header cell. */
+/**
+ * Harness for interacting with a standard Angular Material table header cell.
+ * @deprecated Use `MatHeaderCellHarness` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 export class MatLegacyHeaderCellHarness extends _MatCellHarnessBase {
   /** The selector for the host element of a `MatHeaderCellHarness` instance. */
   static hostSelector = '.mat-header-cell';
@@ -40,7 +48,11 @@ export class MatLegacyHeaderCellHarness extends _MatCellHarnessBase {
   }
 }
 
-/** Harness for interacting with a standard Angular Material table footer cell. */
+/**
+ * Harness for interacting with a standard Angular Material table footer cell.
+ * @deprecated Use `MatFooterCellHarness` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 export class MatLegacyFooterCellHarness extends _MatCellHarnessBase {
   /** The selector for the host element of a `MatFooterCellHarness` instance. */
   static hostSelector = '.mat-footer-cell';
diff --git a/src/material/legacy-table/testing/public-api.ts b/src/material/legacy-table/testing/public-api.ts
@@ -18,12 +18,51 @@ export {
   MatLegacyFooterCellHarness,
 } from './cell-harness';
 export {
+  /**
+   * @deprecated Use `CellHarnessFilters` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   CellHarnessFilters as LegacyCellHarnessFilters,
+
+  /**
+   * @deprecated Use `RowHarnessFilters` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   RowHarnessFilters as LegacyRowHarnessFilters,
+
+  /**
+   * @deprecated Use `TableHarnessFilters` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   TableHarnessFilters as LegacyTableHarnessFilters,
+
+  /**
+   * @deprecated Use `MatRowHarnessColumnsText` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MatRowHarnessColumnsText as MatLegacyRowHarnessColumnsText,
+
+  /**
+   * @deprecated Use `MatTableHarnessColumnsText` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   MatTableHarnessColumnsText as MatLegacyTableHarnessColumnsText,
+
+  /**
+   * @deprecated Use `_MatCellHarnessBase` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   _MatCellHarnessBase as _MatLegacyCellHarnessBase,
+
+  /**
+   * @deprecated Use `_MatRowHarnessBase` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   _MatRowHarnessBase as _MatLegacyRowHarnessBase,
+
+  /**
+   * @deprecated Use `_MatTableHarnessBase` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+   * @breaking-change 17.0.0
+   */
   _MatTableHarnessBase as _MatLegacyTableHarnessBase,
 } from '@angular/material/table/testing';
diff --git a/src/material/legacy-table/testing/row-harness.ts b/src/material/legacy-table/testing/row-harness.ts
@@ -14,7 +14,11 @@ import {
 } from './cell-harness';
 import {_MatRowHarnessBase, RowHarnessFilters} from '@angular/material/table/testing';
 
-/** Harness for interacting with a standard Angular Material table row. */
+/**
+ * Harness for interacting with a standard Angular Material table row.
+ * @deprecated Use `MatRowHarness` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 export class MatLegacyRowHarness extends _MatRowHarnessBase<
   typeof MatLegacyCellHarness,
   MatLegacyCellHarness
@@ -33,7 +37,11 @@ export class MatLegacyRowHarness extends _MatRowHarnessBase<
   }
 }
 
-/** Harness for interacting with a standard Angular Material table header row. */
+/**
+ * Harness for interacting with a standard Angular Material table header row.
+ * @deprecated Use `MatHeaderRowHarness` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 export class MatLegacyHeaderRowHarness extends _MatRowHarnessBase<
   typeof MatLegacyHeaderCellHarness,
   MatLegacyHeaderCellHarness
@@ -53,7 +61,11 @@ export class MatLegacyHeaderRowHarness extends _MatRowHarnessBase<
   }
 }
 
-/** Harness for interacting with a standard Angular Material table footer row. */
+/**
+ * Harness for interacting with a standard Angular Material table footer row.
+ * @deprecated Use `MatFooterRowHarness` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 export class MatLegacyFooterRowHarness extends _MatRowHarnessBase<
   typeof MatLegacyFooterCellHarness,
   MatLegacyFooterCellHarness
diff --git a/src/material/legacy-table/testing/table-harness.ts b/src/material/legacy-table/testing/table-harness.ts
@@ -14,7 +14,11 @@ import {
 } from './row-harness';
 import {_MatTableHarnessBase, TableHarnessFilters} from '@angular/material/table/testing';
 
-/** Harness for interacting with a standard mat-table in tests. */
+/**
+ * Harness for interacting with a standard mat-table in tests.
+ * @deprecated Use `MatTableHarness` from `@angular/material/table/testing` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
+ */
 export class MatLegacyTableHarness extends _MatTableHarnessBase<
   typeof MatLegacyHeaderRowHarness,
   MatLegacyHeaderRowHarness,
diff --git a/src/material/legacy-table/text-column.ts b/src/material/legacy-table/text-column.ts
@@ -17,6 +17,9 @@ import {ChangeDetectionStrategy, Component, ViewEncapsulation} from '@angular/co
  * The header text can be overridden with the `headerText` input. Cell values can be overridden with
  * the `dataAccessor` input. Change the text justification to the start or end using the `justify`
  * input.
+ *
+ * @deprecated Use `MatTextColumn` from `@angular/material/table` instead. See https://material.angular.io/guide/mdc-migration for information about migrating.
+ * @breaking-change 17.0.0
  */
 @Component({
   selector: 'mat-text-column',
diff --git a/tools/public_api_guard/material/legacy-table-testing.md b/tools/public_api_guard/material/legacy-table-testing.md
diff --git a/tools/public_api_guard/material/legacy-table.md b/tools/public_api_guard/material/legacy-table.md
