Merge pull request #7672 from marleypowell/marley/7641-consume-exported-ado-types

refactor(`@backstage/plugin-azure-devops`): Consume re-exported types from `@backstage/plugin-azure-devops-common`.

.changeset/many-mayflies-notice.md

@@ -0,0 +1,9 @@
+---
+'@backstage/plugin-azure-devops': patch
+'@backstage/plugin-azure-devops-backend': minor
+'@backstage/plugin-azure-devops-common': patch
+---
+
+refactor(`@backstage/plugin-azure-devops`): Consume types from `@backstage/plugin-azure-devops-common`.
+Stop re-exporting types from `@backstage/plugin-azure-devops-backend`.
+Added new types to `@backstage/plugin-azure-devops-common`.

plugins/azure-devops-backend/api-report.md

@@ -4,13 +4,13 @@
 
 ```ts
 import { Build } from 'azure-devops-node-api/interfaces/BuildInterfaces';
-import { BuildResult } from 'azure-devops-node-api/interfaces/BuildInterfaces';
-import { BuildStatus } from 'azure-devops-node-api/interfaces/BuildInterfaces';
 import { Config } from '@backstage/config';
 import express from 'express';
 import { GitRepository } from 'azure-devops-node-api/interfaces/GitInterfaces';
 import { Logger as Logger_2 } from 'winston';
-import { PullRequestStatus } from 'azure-devops-node-api/interfaces/GitInterfaces';
+import { PullRequest } from '@backstage/plugin-azure-devops-common';
+import { PullRequestOptions } from '@backstage/plugin-azure-devops-common';
+import { RepoBuild } from '@backstage/plugin-azure-devops-common';
 import { WebApi } from 'azure-devops-node-api';
 
 // Warning: (ae-missing-release-tag) "AzureDevOpsApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -29,8 +29,6 @@ export class AzureDevOpsApi {
     projectName: string,
     repoName: string,
   ): Promise<GitRepository>;
-  // Warning: (ae-forgotten-export) The symbol "PullRequestOptions" needs to be exported by the entry point index.d.ts
-  //
   // (undocumented)
   getPullRequests(
     projectName: string,
@@ -45,48 +43,11 @@ export class AzureDevOpsApi {
   ): Promise<RepoBuild[]>;
 }
 
-export { BuildResult };
-
-export { BuildStatus };
-
 // Warning: (ae-missing-release-tag) "createRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
 export function createRouter(options: RouterOptions): Promise<express.Router>;
 
-// Warning: (ae-missing-release-tag) "PullRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
-export type PullRequest = {
-  pullRequestId?: number;
-  repoName?: string;
-  title?: string;
-  uniqueName?: string;
-  createdBy?: string;
-  creationDate?: Date;
-  sourceRefName?: string;
-  targetRefName?: string;
-  status?: PullRequestStatus;
-  isDraft?: boolean;
-  link: string;
-};
-
-// Warning: (ae-missing-release-tag) "RepoBuild" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
-export type RepoBuild = {
-  id?: number;
-  title: string;
-  link?: string;
-  status?: BuildStatus;
-  result?: BuildResult;
-  queueTime?: Date;
-  startTime?: Date;
-  finishTime?: Date;
-  source: string;
-  uniqueName?: string;
-};
-
 // Warning: (ae-missing-release-tag) "RouterOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)

plugins/azure-devops-backend/package.json

@@ -22,6 +22,7 @@
   "dependencies": {
     "@backstage/backend-common": "^0.9.8",
     "@backstage/config": "^0.1.11",
+    "@backstage/plugin-azure-devops-common": "^0.0.1",
     "@types/express": "^4.17.6",
     "azure-devops-node-api": "^11.0.1",
     "express": "^4.17.1",

plugins/azure-devops-backend/src/api/AzureDevOpsApi.test.ts

@@ -16,17 +16,21 @@
 
 import {
   Build,
+  DefinitionReference,
+} from 'azure-devops-node-api/interfaces/BuildInterfaces';
+import {
   BuildResult,
   BuildStatus,
-  GitPullRequest,
-  GitRepository,
   PullRequest,
   PullRequestStatus,
   RepoBuild,
-} from './types';
+} from '@backstage/plugin-azure-devops-common';
+import {
+  GitPullRequest,
+  GitRepository,
+} from 'azure-devops-node-api/interfaces/GitInterfaces';
 import { mappedPullRequest, mappedRepoBuild } from './AzureDevOpsApi';
 
-import { DefinitionReference } from 'azure-devops-node-api/interfaces/BuildInterfaces';
 import { IdentityRef } from 'azure-devops-node-api/interfaces/common/VSSInterfaces';
 
 describe('AzureDevOpsApi', () => {

plugins/azure-devops-backend/src/api/AzureDevOpsApi.ts

@@ -15,17 +15,19 @@
  */
 
 import {
-  Build,
   BuildResult,
   BuildStatus,
-  GitPullRequest,
-  GitPullRequestSearchCriteria,
-  GitRepository,
   PullRequest,
   PullRequestOptions,
   RepoBuild,
-} from './types';
+} from '@backstage/plugin-azure-devops-common';
+import {
+  GitPullRequest,
+  GitPullRequestSearchCriteria,
+  GitRepository,
+} from 'azure-devops-node-api/interfaces/GitInterfaces';
 
+import { Build } from 'azure-devops-node-api/interfaces/BuildInterfaces';
 import { Logger } from 'winston';
 import { WebApi } from 'azure-devops-node-api';
 

plugins/azure-devops-backend/src/api/index.ts

@@ -15,5 +15,3 @@
  */
 
 export { AzureDevOpsApi } from './AzureDevOpsApi';
-export { BuildResult, BuildStatus } from './types';
-export type { RepoBuild, PullRequest } from './types';

plugins/azure-devops-backend/src/api/types.ts

@@ -1,67 +0,0 @@
-/*
- * Copyright 2021 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import {
-  Build,
-  BuildResult,
-  BuildStatus,
-} from 'azure-devops-node-api/interfaces/BuildInterfaces';
-import {
-  GitPullRequest,
-  GitPullRequestSearchCriteria,
-  GitRepository,
-  PullRequestStatus,
-} from 'azure-devops-node-api/interfaces/GitInterfaces';
-
-export { BuildResult, BuildStatus, PullRequestStatus };
-export type {
-  Build,
-  GitPullRequest,
-  GitPullRequestSearchCriteria,
-  GitRepository,
-};
-
-export type RepoBuild = {
-  id?: number;
-  title: string;
-  link?: string;
-  status?: BuildStatus;
-  result?: BuildResult;
-  queueTime?: Date;
-  startTime?: Date;
-  finishTime?: Date;
-  source: string;
-  uniqueName?: string;
-};
-
-export type PullRequest = {
-  pullRequestId?: number;
-  repoName?: string;
-  title?: string;
-  uniqueName?: string;
-  createdBy?: string;
-  creationDate?: Date;
-  sourceRefName?: string;
-  targetRefName?: string;
-  status?: PullRequestStatus;
-  isDraft?: boolean;
-  link: string;
-};
-
-export type PullRequestOptions = {
-  top: number;
-  status: PullRequestStatus;
-};

plugins/azure-devops-backend/src/index.ts

@@ -13,6 +13,5 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { AzureDevOpsApi, BuildResult, BuildStatus } from './api';
-export type { RepoBuild, PullRequest } from './api';
+export { AzureDevOpsApi } from './api';
 export * from './service/router';

plugins/azure-devops-backend/src/service/router.test.ts

@@ -14,22 +14,22 @@
  * limitations under the License.
  */
 
-import { getVoidLogger } from '@backstage/backend-common';
-import { ConfigReader } from '@backstage/config';
-import express from 'express';
-import request from 'supertest';
-import { AzureDevOpsApi } from '../api';
-import { createRouter } from './router';
-import { PullRequest, RepoBuild } from '../api/types';
 import {
-  GitRepository,
-  PullRequestStatus,
-} from 'azure-devops-node-api/interfaces/GitInterfaces';
-import {
-  Build,
   BuildResult,
   BuildStatus,
-} from 'azure-devops-node-api/interfaces/BuildInterfaces';
+  PullRequest,
+  PullRequestStatus,
+  RepoBuild,
+} from '@backstage/plugin-azure-devops-common';
+
+import { AzureDevOpsApi } from '../api';
+import { Build } from 'azure-devops-node-api/interfaces/BuildInterfaces';
+import { ConfigReader } from '@backstage/config';
+import { GitRepository } from 'azure-devops-node-api/interfaces/GitInterfaces';
+import { createRouter } from './router';
+import express from 'express';
+import { getVoidLogger } from '@backstage/backend-common';
+import request from 'supertest';
 
 describe('createRouter', () => {
   let azureDevOpsApi: jest.Mocked<AzureDevOpsApi>;

plugins/azure-devops-backend/src/service/router.ts

@@ -14,7 +14,10 @@
  * limitations under the License.
  */
 
-import { PullRequestOptions, PullRequestStatus } from '../api/types';
+import {
+  PullRequestOptions,
+  PullRequestStatus,
+} from '@backstage/plugin-azure-devops-common';
 import { WebApi, getPersonalAccessTokenHandler } from 'azure-devops-node-api';
 
 import { AzureDevOpsApi } from '../api';

plugins/azure-devops-common/api-report.md

@@ -27,6 +27,42 @@ export enum BuildStatus {
   Postponed = 8,
 }
 
+// Warning: (ae-missing-release-tag) "PullRequest" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type PullRequest = {
+  pullRequestId?: number;
+  repoName?: string;
+  title?: string;
+  uniqueName?: string;
+  createdBy?: string;
+  creationDate?: Date;
+  sourceRefName?: string;
+  targetRefName?: string;
+  status?: PullRequestStatus;
+  isDraft?: boolean;
+  link: string;
+};
+
+// Warning: (ae-missing-release-tag) "PullRequestOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type PullRequestOptions = {
+  top: number;
+  status: PullRequestStatus;
+};
+
+// Warning: (ae-missing-release-tag) "PullRequestStatus" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export enum PullRequestStatus {
+  Abandoned = 2,
+  Active = 1,
+  All = 4,
+  Completed = 3,
+  NotSet = 0,
+}
+
 // Warning: (ae-missing-release-tag) "RepoBuild" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
@@ -43,5 +79,12 @@ export type RepoBuild = {
   uniqueName?: string;
 };
 
+// Warning: (ae-missing-release-tag) "RepoBuildOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export type RepoBuildOptions = {
+  top?: number;
+};
+
 // (No @packageDocumentation comment for this package)
 ```

plugins/azure-devops-common/src/types.ts

@@ -80,3 +80,49 @@ export type RepoBuild = {
   source: string;
   uniqueName?: string;
 };
+
+export type RepoBuildOptions = {
+  top?: number;
+};
+
+export enum PullRequestStatus {
+  /**
+   * Status not set. Default state.
+   */
+  NotSet = 0,
+  /**
+   * Pull request is active.
+   */
+  Active = 1,
+  /**
+   * Pull request is abandoned.
+   */
+  Abandoned = 2,
+  /**
+   * Pull request is completed.
+   */
+  Completed = 3,
+  /**
+   * Used in pull request search criteria to include all statuses.
+   */
+  All = 4,
+}
+
+export type PullRequest = {
+  pullRequestId?: number;
+  repoName?: string;
+  title?: string;
+  uniqueName?: string;
+  createdBy?: string;
+  creationDate?: Date;
+  sourceRefName?: string;
+  targetRefName?: string;
+  status?: PullRequestStatus;
+  isDraft?: boolean;
+  link: string;
+};
+
+export type PullRequestOptions = {
+  top: number;
+  status: PullRequestStatus;
+};

plugins/azure-devops/package.json

@@ -37,7 +37,6 @@
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.57",
-    "azure-devops-node-api": "^11.0.1",
     "luxon": "^2.0.2",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",

plugins/azure-devops/src/api/AzureDevOpsApi.ts

@@ -14,7 +14,11 @@
  * limitations under the License.
  */
 
-import { RepoBuild, RepoBuildOptions } from './types';
+import {
+  RepoBuild,
+  RepoBuildOptions,
+} from '@backstage/plugin-azure-devops-common';
+
 import { createApiRef } from '@backstage/core-plugin-api';
 
 export const azureDevOpsApiRef = createApiRef<AzureDevOpsApi>({

plugins/azure-devops/src/api/AzureDevOpsClient.ts

@@ -14,9 +14,13 @@
  * limitations under the License.
  */
 
-import { AzureDevOpsApi } from './AzureDevOpsApi';
-import { RepoBuild, RepoBuildOptions } from './types';
 import { DiscoveryApi, IdentityApi } from '@backstage/core-plugin-api';
+import {
+  RepoBuild,
+  RepoBuildOptions,
+} from '@backstage/plugin-azure-devops-common';
+
+import { AzureDevOpsApi } from './AzureDevOpsApi';
 import { ResponseError } from '@backstage/errors';
 
 export class AzureDevOpsClient implements AzureDevOpsApi {

plugins/azure-devops/src/api/types.ts

@@ -1,34 +0,0 @@
-/*
- * Copyright 2021 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import {
-  BuildResult,
-  BuildStatus,
-} from 'azure-devops-node-api/interfaces/BuildInterfaces';
-
-export type RepoBuild = {
-  id?: number;
-  title: string;
-  link?: string;
-  status?: BuildStatus;
-  result?: BuildResult;
-  queueTime?: Date;
-  source: string;
-};
-
-export type RepoBuildOptions = {
-  top?: number;
-};

plugins/azure-devops/src/components/BuildTable/BuildTable.test.ts

@@ -17,7 +17,7 @@
 import {
   BuildResult,
   BuildStatus,
-} from 'azure-devops-node-api/interfaces/BuildInterfaces';
+} from '@backstage/plugin-azure-devops-common';
 import { getBuildResultComponent, getBuildStateComponent } from './BuildTable';
 
 import { renderInTestApp } from '@backstage/test-utils';

plugins/azure-devops/src/components/BuildTable/BuildTable.tsx

@@ -18,7 +18,8 @@ import { Box, Typography } from '@material-ui/core';
 import {
   BuildResult,
   BuildStatus,
-} from 'azure-devops-node-api/interfaces/BuildInterfaces';
+  RepoBuild,
+} from '@backstage/plugin-azure-devops-common';
 import {
   Link,
   ResponseErrorPanel,
@@ -34,7 +35,6 @@ import {
 
 import { DateTime } from 'luxon';
 import React from 'react';
-import { RepoBuild } from '../../api/types';
 
 export const getBuildResultComponent = (result: number | undefined) => {
   switch (result) {

plugins/azure-devops/src/hooks/useRepoBuilds.ts

@@ -14,7 +14,10 @@
  * limitations under the License.
  */
 
-import { RepoBuild, RepoBuildOptions } from '../api/types';
+import {
+  RepoBuild,
+  RepoBuildOptions,
+} from '@backstage/plugin-azure-devops-common';
 
 import { AZURE_DEVOPS_DEFAULT_TOP } from '../constants';
 import { Entity } from '@backstage/catalog-model';