move types to catalog-common

Signed-off-by: Kiss Miklos <miklos@roadie.io>

plugins/catalog-backend/src/ingestion/LocationAnalyzer.ts

@@ -18,12 +18,11 @@ import { Logger } from 'winston';
 import parseGitUrl from 'git-url-parse';
 import { Entity } from '@backstage/catalog-model';
 import { ScmIntegrationRegistry } from '@backstage/integration';
+import { LocationAnalyzer, ScmLocationAnalyzer } from './types';
 import {
   AnalyzeLocationRequest,
   AnalyzeLocationResponse,
-  LocationAnalyzer,
-  ScmLocationAnalyzer,
-} from './types';
+} from '@backstage/plugin-catalog-common';
 
 export class RepoLocationAnalyzer implements LocationAnalyzer {
   private readonly logger: Logger;

plugins/catalog-backend/src/ingestion/index.ts

@@ -15,11 +15,6 @@
  */
 
 export type {
-  AnalyzeLocationEntityField,
-  AnalyzeLocationExistingEntity,
-  AnalyzeLocationGenerateEntity,
-  AnalyzeLocationRequest,
-  AnalyzeLocationResponse,
   LocationAnalyzer,
   ScmLocationAnalyzer,
   AnalyzeOptions,

plugins/catalog-backend/src/ingestion/types.ts

@@ -13,10 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-import { Entity } from '@backstage/catalog-model';
-import { RecursivePartial } from '../util/RecursivePartial';
-import { LocationSpec } from '@backstage/plugin-catalog-node';
+import {
+  AnalyzeLocationResponse,
+  AnalyzeLocationRequest,
+  AnalyzeLocationExistingEntity,
+} from '@backstage/plugin-catalog-common';
 
 /** @public */
 export type LocationAnalyzer = {
@@ -31,75 +32,6 @@ export type LocationAnalyzer = {
   ): Promise<AnalyzeLocationResponse>;
 };
 
-/** @public */
-export type AnalyzeLocationRequest = {
-  location: LocationSpec;
-  catalogFilename?: string;
-};
-
-/** @public */
-export type AnalyzeLocationResponse = {
-  existingEntityFiles: AnalyzeLocationExistingEntity[];
-  generateEntities: AnalyzeLocationGenerateEntity[];
-};
-
-/**
- * If the folder pointed to already contained catalog info yaml files, they are
- * read and emitted like this so that the frontend can inform the user that it
- * located them and can make sure to register them as well if they weren't
- * already
- * @public
- */
-export type AnalyzeLocationExistingEntity = {
-  location: LocationSpec;
-  isRegistered: boolean;
-  entity: Entity;
-};
-
-/**
- * This is some form of representation of what the analyzer could deduce.
- * We should probably have a chat about how this can best be conveyed to
- * the frontend. It'll probably contain a (possibly incomplete) entity, plus
- * enough info for the frontend to know what form data to show to the user
- * for overriding/completing the info.
- * @public
- */
-export type AnalyzeLocationGenerateEntity = {
-  // Some form of partial representation of the entity
-  entity: RecursivePartial<Entity>;
-  // Lists the suggestions that the user may want to override
-  fields: AnalyzeLocationEntityField[];
-};
-
-// This is where I get really vague. Something like this perhaps? Or it could be
-// something like a json-schema that contains enough info for the frontend to
-// be able to present a form and explanations
-/** @public */
-export type AnalyzeLocationEntityField = {
-  /**
-   * e.g. "spec.owner"? The frontend needs to know how to "inject" the field into the
-   * entity again if the user wants to change it
-   */
-  field: string;
-
-  /** The outcome of the analysis for this particular field */
-  state:
-    | 'analysisSuggestedValue'
-    | 'analysisSuggestedNoValue'
-    | 'needsUserInput';
-
-  // If the analysis did suggest a value, this is where it would be. Not sure if we want
-  // to limit this to strings or if we want it to be any JsonValue
-  value: string | null;
-  /**
-   * A text to show to the user to inform about the choices made. Like, it could say
-   * "Found a CODEOWNERS file that covers this target, so we suggest leaving this
-   * field empty; which would currently make it owned by X" where X is taken from the
-   * codeowners file.
-   */
-  description: string;
-};
-
 /** @public */
 export type AnalyzeOptions = {
   url: string;

plugins/catalog-common/package.json

@@ -33,6 +33,8 @@
     "clean": "backstage-cli package clean"
   },
   "dependencies": {
+    "@backstage/catalog-model": "workspace:^",
+    "@backstage/plugin-catalog-node": "workspace:^",
     "@backstage/plugin-permission-common": "workspace:^",
     "@backstage/plugin-search-common": "workspace:^"
   },

plugins/catalog-common/src/index.ts

@@ -35,3 +35,4 @@ export {
 export type { CatalogEntityPermission } from './permissions';
 
 export * from './search';
+export * from './ingestion';

plugins/catalog-common/src/ingestion/LocationAnalyzer.ts

@@ -0,0 +1,88 @@
+/*
+ * Copyright 2022 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 { LocationSpec } from '@backstage/plugin-catalog-node';
+import { Entity } from '@backstage/catalog-model';
+import { RecursivePartial } from './RecursivePartial';
+
+/** @public */
+export type AnalyzeLocationRequest = {
+  location: LocationSpec;
+  catalogFilename?: string;
+};
+
+/** @public */
+export type AnalyzeLocationResponse = {
+  existingEntityFiles: AnalyzeLocationExistingEntity[];
+  generateEntities: AnalyzeLocationGenerateEntity[];
+};
+
+/**
+ * If the folder pointed to already contained catalog info yaml files, they are
+ * read and emitted like this so that the frontend can inform the user that it
+ * located them and can make sure to register them as well if they weren't
+ * already
+ * @public
+ */
+export type AnalyzeLocationExistingEntity = {
+  location: LocationSpec;
+  isRegistered: boolean;
+  entity: Entity;
+};
+
+/**
+ * This is some form of representation of what the analyzer could deduce.
+ * We should probably have a chat about how this can best be conveyed to
+ * the frontend. It'll probably contain a (possibly incomplete) entity, plus
+ * enough info for the frontend to know what form data to show to the user
+ * for overriding/completing the info.
+ * @public
+ */
+export type AnalyzeLocationGenerateEntity = {
+  // Some form of partial representation of the entity
+  entity: RecursivePartial<Entity>;
+  // Lists the suggestions that the user may want to override
+  fields: AnalyzeLocationEntityField[];
+};
+
+// This is where I get really vague. Something like this perhaps? Or it could be
+// something like a json-schema that contains enough info for the frontend to
+// be able to present a form and explanations
+/** @public */
+export type AnalyzeLocationEntityField = {
+  /**
+   * e.g. "spec.owner"? The frontend needs to know how to "inject" the field into the
+   * entity again if the user wants to change it
+   */
+  field: string;
+
+  /** The outcome of the analysis for this particular field */
+  state:
+    | 'analysisSuggestedValue'
+    | 'analysisSuggestedNoValue'
+    | 'needsUserInput';
+
+  // If the analysis did suggest a value, this is where it would be. Not sure if we want
+  // to limit this to strings or if we want it to be any JsonValue
+  value: string | null;
+  /**
+   * A text to show to the user to inform about the choices made. Like, it could say
+   * "Found a CODEOWNERS file that covers this target, so we suggest leaving this
+   * field empty; which would currently make it owned by X" where X is taken from the
+   * codeowners file.
+   */
+  description: string;
+};

plugins/catalog-common/src/ingestion/RecursivePartial.test.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2020 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 { RecursivePartial } from './RecursivePartial';
+
+describe('RecursivePartial', () => {
+  it('is recursive', () => {
+    type X = {
+      required: {
+        required: string;
+      };
+    };
+    const x: RecursivePartial<X> = {
+      required: {},
+    };
+    expect(x).toEqual({ required: {} });
+  });
+});

plugins/catalog-common/src/ingestion/RecursivePartial.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2020 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.
+ */
+
+/**
+ * Makes all keys of an entire hierarchy optional.
+ * @ignore
+ */
+export type RecursivePartial<T> = {
+  [P in keyof T]?: T[P] extends (infer U)[]
+    ? RecursivePartial<U>[]
+    : T[P] extends object
+    ? RecursivePartial<T[P]>
+    : T[P];
+};

plugins/catalog-common/src/ingestion/index.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2022 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.
+ */
+
+export type {
+  AnalyzeLocationResponse,
+  AnalyzeLocationRequest,
+  AnalyzeLocationExistingEntity,
+} from './LocationAnalyzer';

plugins/catalog-import/package.json

@@ -40,7 +40,7 @@
     "@backstage/errors": "workspace:^",
     "@backstage/integration": "workspace:^",
     "@backstage/integration-react": "workspace:^",
-    "@backstage/plugin-catalog-backend": "workspace:^",
+    "@backstage/plugin-catalog-common": "workspace:^",
     "@backstage/plugin-catalog-react": "workspace:^",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",

plugins/catalog-import/src/api/CatalogImportClient.ts

@@ -30,7 +30,7 @@ import { Base64 } from 'js-base64';
 import { AnalyzeResult, CatalogImportApi } from './CatalogImportApi';
 import { getGithubIntegrationConfig } from './GitHub';
 import { getBranchName, getCatalogFilename } from '../components/helpers';
-import { AnalyzeLocationResponse } from '@backstage/plugin-catalog-backend';
+import { AnalyzeLocationResponse } from '@backstage/plugin-catalog-common';
 import { CompoundEntityRef } from '@backstage/catalog-model';
 
 /**

yarn.lock

@@ -4718,7 +4718,9 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "@backstage/plugin-catalog-common@workspace:plugins/catalog-common"
   dependencies:
+    "@backstage/catalog-model": "workspace:^"
     "@backstage/cli": "workspace:^"
+    "@backstage/plugin-catalog-node": "workspace:^"
     "@backstage/plugin-permission-common": "workspace:^"
     "@backstage/plugin-search-common": "workspace:^"
   languageName: unknown
@@ -4799,7 +4801,7 @@ __metadata:
     "@backstage/errors": "workspace:^"
     "@backstage/integration": "workspace:^"
     "@backstage/integration-react": "workspace:^"
-    "@backstage/plugin-catalog-backend": "workspace:^"
+    "@backstage/plugin-catalog-common": "workspace:^"
     "@backstage/plugin-catalog-react": "workspace:^"
     "@backstage/test-utils": "workspace:^"
     "@material-ui/core": ^4.12.2