@backstage/plugin-catalog-unprocessed-entities 0.2.24-next.0 → 0.2.24

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @backstage/plugin-catalog-unprocessed-entities
 
+## 0.2.24
+
+### Patch Changes
+
+- d02db50: Remove unnecessary use of `compatWrapper` and `convertLegacyRouteRef`(s) for the new frontend system.
+- df4d646: Moved types, API and client to the common package, allowing both frontend and
+  backend plugins to use the `CatalogUnprocessedEntitiesClient`.
+
+  The following types, clients and interfaces have been deprecated and should be
+  imported from the `@backstage/plugin-catalog-unprocessed-entities-common` instead:
+  `CatalogUnprocessedEntitiesApi`, `CatalogUnprocessedEntitiesApiResponse`, `UnprocessedEntity`,
+  `UnprocessedEntityCache`, `UnprocessedEntityError`, `CatalogUnprocessedEntitiesClient`.
+
+  All those types, clients and interfaces are re-exported temporarily in the
+  `@backstage/plugin-catalog-unprocessed-entities` package until cleaned up.
+
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.13.2
+  - @backstage/core-components@0.18.4
+  - @backstage/core-plugin-api@1.12.1
+  - @backstage/plugin-catalog-unprocessed-entities-common@0.0.12
+
+## 0.2.24-next.1
+
+### Patch Changes
+
+- df4d646: Moved types, API and client to the common package, allowing both frontend and
+  backend plugins to use the `CatalogUnprocessedEntitiesClient`.
+
+  The following types, clients and interfaces have been deprecated and should be
+  imported from the `@backstage/plugin-catalog-unprocessed-entities-common` instead:
+  `CatalogUnprocessedEntitiesApi`, `CatalogUnprocessedEntitiesApiResponse`, `UnprocessedEntity`,
+  `UnprocessedEntityCache`, `UnprocessedEntityError`, `CatalogUnprocessedEntitiesClient`.
+
+  All those types, clients and interfaces are re-exported temporarily in the
+  `@backstage/plugin-catalog-unprocessed-entities` package until cleaned up.
+
+- Updated dependencies
+  - @backstage/core-components@0.18.4-next.1
+  - @backstage/plugin-catalog-unprocessed-entities-common@0.0.12-next.0
+
 ## 0.2.24-next.0
 
 ### Patch Changes

package/dist/api/index.esm.js

@@ -1,35 +1,10 @@
 import { createApiRef } from '@backstage/core-plugin-api';
-import { ResponseError } from '@backstage/errors';
+import { CatalogUnprocessedEntitiesClient as CatalogUnprocessedEntitiesClient$1 } from '@backstage/plugin-catalog-unprocessed-entities-common';
 
 const catalogUnprocessedEntitiesApiRef = createApiRef({
   id: "plugin.catalog-unprocessed-entities.service"
 });
-class CatalogUnprocessedEntitiesClient {
-  discovery;
-  fetchApi;
-  constructor(discovery, fetchApi) {
-    this.discovery = discovery;
-    this.fetchApi = fetchApi;
-  }
-  async fetch(path, init) {
-    const url = await this.discovery.getBaseUrl("catalog");
-    const resp = await this.fetchApi.fetch(`${url}/${path}`, init);
-    if (!resp.ok) {
-      throw await ResponseError.fromResponse(resp);
-    }
-    return resp.status === 204 ? resp : await resp.json();
-  }
-  async pending() {
-    return await this.fetch("entities/unprocessed/pending");
-  }
-  async failed() {
-    return await this.fetch("entities/unprocessed/failed");
-  }
-  async delete(entityId) {
-    await this.fetch(`entities/unprocessed/delete/${entityId}`, {
-      method: "DELETE"
-    });
-  }
+class CatalogUnprocessedEntitiesClient extends CatalogUnprocessedEntitiesClient$1 {
 }
 
 export { CatalogUnprocessedEntitiesClient, catalogUnprocessedEntitiesApiRef };

package/dist/api/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":["../../src/api/index.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport {\n  DiscoveryApi,\n  createApiRef,\n  FetchApi,\n} from '@backstage/core-plugin-api';\nimport { ResponseError } from '@backstage/errors';\nimport { UnprocessedEntity } from '../types';\n\n/**\n * {@link @backstage/core-plugin-api#ApiRef} for the {@link CatalogUnprocessedEntitiesApi}\n *\n * @public\n */\nexport const catalogUnprocessedEntitiesApiRef =\n  createApiRef<CatalogUnprocessedEntitiesApi>({\n    id: 'plugin.catalog-unprocessed-entities.service',\n  });\n\n/**\n * Response expected by the {@link CatalogUnprocessedEntitiesApi}\n *\n * @public\n */\nexport type CatalogUnprocessedEntitiesApiResponse = {\n  entities: UnprocessedEntity[];\n};\n\n/**\n * Interface for the CatalogUnprocessedEntitiesApi.\n *\n * @public\n */\nexport interface CatalogUnprocessedEntitiesApi {\n  /**\n   * Returns a list of entities with state 'pending'\n   */\n  pending(): Promise<CatalogUnprocessedEntitiesApiResponse>;\n  /**\n   * Returns a list of entities with state 'failed'\n   */\n  failed(): Promise<CatalogUnprocessedEntitiesApiResponse>;\n  /**\n   * Deletes an entity from the refresh_state table\n   */\n  delete(entityId: string): Promise<void>;\n}\n\n/**\n * Default API implementation for the Catalog Unprocessed Entities plugin\n *\n * @public\n */\nexport class CatalogUnprocessedEntitiesClient\n  implements CatalogUnprocessedEntitiesApi\n{\n  public discovery: DiscoveryApi;\n  public fetchApi: FetchApi;\n\n  constructor(discovery: DiscoveryApi, fetchApi: FetchApi) {\n    this.discovery = discovery;\n    this.fetchApi = fetchApi;\n  }\n\n  private async fetch<T>(path: string, init?: RequestInit): Promise<T> {\n    const url = await this.discovery.getBaseUrl('catalog');\n    const resp = await this.fetchApi.fetch(`${url}/${path}`, init);\n\n    if (!resp.ok) {\n      throw await ResponseError.fromResponse(resp);\n    }\n\n    return resp.status === 204 ? (resp as T) : await resp.json();\n  }\n\n  async pending(): Promise<CatalogUnprocessedEntitiesApiResponse> {\n    return await this.fetch('entities/unprocessed/pending');\n  }\n\n  async failed(): Promise<CatalogUnprocessedEntitiesApiResponse> {\n    return await this.fetch('entities/unprocessed/failed');\n  }\n\n  async delete(entityId: string): Promise<void> {\n    await this.fetch(`entities/unprocessed/delete/${entityId}`, {\n      method: 'DELETE',\n    });\n  }\n}\n"],"names":[],"mappings":";;;AA4BO,MAAM,mCACX,YAAA,CAA4C;AAAA,EAC1C,EAAA,EAAI;AACN,CAAC;AAoCI,MAAM,gCAAA,CAEb;AAAA,EACS,SAAA;AAAA,EACA,QAAA;AAAA,EAEP,WAAA,CAAY,WAAyB,QAAA,EAAoB;AACvD,IAAA,IAAA,CAAK,SAAA,GAAY,SAAA;AACjB,IAAA,IAAA,CAAK,QAAA,GAAW,QAAA;AAAA,EAClB;AAAA,EAEA,MAAc,KAAA,CAAS,IAAA,EAAc,IAAA,EAAgC;AACnE,IAAA,MAAM,GAAA,GAAM,MAAM,IAAA,CAAK,SAAA,CAAU,WAAW,SAAS,CAAA;AACrD,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,QAAA,CAAS,KAAA,CAAM,GAAG,GAAG,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA;AAE7D,IAAA,IAAI,CAAC,KAAK,EAAA,EAAI;AACZ,MAAA,MAAM,MAAM,aAAA,CAAc,YAAA,CAAa,IAAI,CAAA;AAAA,IAC7C;AAEA,IAAA,OAAO,KAAK,MAAA,KAAW,GAAA,GAAO,IAAA,GAAa,MAAM,KAAK,IAAA,EAAK;AAAA,EAC7D;AAAA,EAEA,MAAM,OAAA,GAA0D;AAC9D,IAAA,OAAO,MAAM,IAAA,CAAK,KAAA,CAAM,8BAA8B,CAAA;AAAA,EACxD;AAAA,EAEA,MAAM,MAAA,GAAyD;AAC7D,IAAA,OAAO,MAAM,IAAA,CAAK,KAAA,CAAM,6BAA6B,CAAA;AAAA,EACvD;AAAA,EAEA,MAAM,OAAO,QAAA,EAAiC;AAC5C,IAAA,MAAM,IAAA,CAAK,KAAA,CAAM,CAAA,4BAAA,EAA+B,QAAQ,CAAA,CAAA,EAAI;AAAA,MAC1D,MAAA,EAAQ;AAAA,KACT,CAAA;AAAA,EACH;AACF;;;;"}
+{"version":3,"file":"index.esm.js","sources":["../../src/api/index.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\nimport { createApiRef } from '@backstage/core-plugin-api';\nimport {\n  CatalogUnprocessedEntitiesApiResponse as CommonCatalogUnprocessedEntitiesApiResponse,\n  CatalogUnprocessedEntitiesApi as CommonCatalogUnprocessedEntitiesApi,\n  CatalogUnprocessedEntitiesClient as CommonCatalogUnprocessedEntitiesClient,\n} from '@backstage/plugin-catalog-unprocessed-entities-common';\n\n/**\n * {@link @backstage/core-plugin-api#ApiRef} for the {@link CatalogUnprocessedEntitiesApi}\n *\n * @public\n */\nexport const catalogUnprocessedEntitiesApiRef =\n  createApiRef<CatalogUnprocessedEntitiesApi>({\n    id: 'plugin.catalog-unprocessed-entities.service',\n  });\n\n/**\n * Response expected by the {@link CatalogUnprocessedEntitiesApi}\n *\n * @public\n * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.\n */\nexport type CatalogUnprocessedEntitiesApiResponse =\n  CommonCatalogUnprocessedEntitiesApiResponse;\n\n/**\n * Interface for the CatalogUnprocessedEntitiesApi.\n *\n * @public\n * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.\n */\nexport interface CatalogUnprocessedEntitiesApi\n  extends CommonCatalogUnprocessedEntitiesApi {}\n\n/**\n * Default API implementation for the Catalog Unprocessed Entities plugin\n *\n * @public\n * @deprecated Use the client imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.\n */\nexport class CatalogUnprocessedEntitiesClient extends CommonCatalogUnprocessedEntitiesClient {}\n"],"names":["CommonCatalogUnprocessedEntitiesClient"],"mappings":";;;AA2BO,MAAM,mCACX,YAAA,CAA4C;AAAA,EAC1C,EAAA,EAAI;AACN,CAAC;AA0BI,MAAM,yCAAyCA,kCAAA,CAAuC;AAAC;;;;"}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
-import { Entity } from '@backstage/catalog-model';
+import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
+import { CatalogUnprocessedEntitiesApiResponse as CatalogUnprocessedEntitiesApiResponse$1, CatalogUnprocessedEntitiesApi as CatalogUnprocessedEntitiesApi$1, UnprocessedEntity as UnprocessedEntity$1, UnprocessedEntityCache as UnprocessedEntityCache$1, UnprocessedEntityError as UnprocessedEntityError$1 } from '@backstage/plugin-catalog-unprocessed-entities-common';
 
 /**
  * Plugin entry point
@@ -21,76 +22,45 @@ declare const CatalogUnprocessedEntitiesPage: () => react_jsx_runtime.JSX.Elemen
 declare const UnprocessedEntitiesContent: () => react_jsx_runtime.JSX.Element;
 
 /**
- * Unprocessed entity data stored in the database.
+ * {@link @backstage/core-plugin-api#ApiRef} for the {@link CatalogUnprocessedEntitiesApi}
+ *
  * @public
  */
-type UnprocessedEntity = {
-    entity_id: string;
-    entity_ref: string;
-    unprocessed_entity: Entity;
-    unprocessed_hash?: string;
-    processed_entity?: Entity;
-    result_hash?: string;
-    cache?: UnprocessedEntityCache;
-    next_update_at: string | Date;
-    last_discovery_at: string | Date;
-    errors?: UnprocessedEntityError[];
-    location_key?: string;
-};
+declare const catalogUnprocessedEntitiesApiRef: _backstage_frontend_plugin_api.ApiRef<CatalogUnprocessedEntitiesApi>;
 /**
- * Unprocessed entity cache stored in the database.
+ * Response expected by the {@link CatalogUnprocessedEntitiesApi}
+ *
  * @public
+ * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
  */
-type UnprocessedEntityCache = {
-    ttl: number;
-    cache: object;
-};
+type CatalogUnprocessedEntitiesApiResponse = CatalogUnprocessedEntitiesApiResponse$1;
 /**
- * Unprocessed entity error information stored in the database.
+ * Interface for the CatalogUnprocessedEntitiesApi.
+ *
  * @public
+ * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
  */
-type UnprocessedEntityError = {
-    name: string;
-    message: string;
-    cause: {
-        name: string;
-        message: string;
-        stack: string;
-    };
-};
+interface CatalogUnprocessedEntitiesApi extends CatalogUnprocessedEntitiesApi$1 {
+}
 
 /**
- * {@link @backstage/core-plugin-api#ApiRef} for the {@link CatalogUnprocessedEntitiesApi}
- *
+ * Unprocessed entity data stored in the database.
  * @public
+ * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
  */
-declare const catalogUnprocessedEntitiesApiRef: _backstage_core_plugin_api.ApiRef<CatalogUnprocessedEntitiesApi>;
+type UnprocessedEntity = UnprocessedEntity$1;
 /**
- * Response expected by the {@link CatalogUnprocessedEntitiesApi}
- *
+ * Unprocessed entity cache stored in the database.
  * @public
+ * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
  */
-type CatalogUnprocessedEntitiesApiResponse = {
-    entities: UnprocessedEntity[];
-};
+type UnprocessedEntityCache = UnprocessedEntityCache$1;
 /**
- * Interface for the CatalogUnprocessedEntitiesApi.
- *
+ * Unprocessed entity error information stored in the database.
  * @public
+ * @deprecated Use the type imported from `@backstage/plugin-catalog-unprocessed-entities-common` instead.
  */
-interface CatalogUnprocessedEntitiesApi {
-    /**
-     * Returns a list of entities with state 'pending'
-     */
-    pending(): Promise<CatalogUnprocessedEntitiesApiResponse>;
-    /**
-     * Returns a list of entities with state 'failed'
-     */
-    failed(): Promise<CatalogUnprocessedEntitiesApiResponse>;
-    /**
-     * Deletes an entity from the refresh_state table
-     */
-    delete(entityId: string): Promise<void>;
-}
+type UnprocessedEntityError = UnprocessedEntityError$1;
 
-export { type CatalogUnprocessedEntitiesApi, type CatalogUnprocessedEntitiesApiResponse, CatalogUnprocessedEntitiesPage, UnprocessedEntitiesContent, type UnprocessedEntity, type UnprocessedEntityCache, type UnprocessedEntityError, catalogUnprocessedEntitiesApiRef, catalogUnprocessedEntitiesPlugin };
+export { CatalogUnprocessedEntitiesPage, UnprocessedEntitiesContent, catalogUnprocessedEntitiesApiRef, catalogUnprocessedEntitiesPlugin };
+export type { CatalogUnprocessedEntitiesApi, CatalogUnprocessedEntitiesApiResponse, UnprocessedEntity, UnprocessedEntityCache, UnprocessedEntityError };

package/dist/package.json.esm.js

@@ -1,5 +1,5 @@
 var name = "@backstage/plugin-catalog-unprocessed-entities";
-var version = "0.2.24-next.0";
+var version = "0.2.24";
 var backstage = {
 	role: "frontend-plugin",
 	pluginId: "catalog-unprocessed-entities",
@@ -19,7 +19,7 @@ var repository = {
 };
 var license = "Apache-2.0";
 var sideEffects = false;
-var exports = {
+var exports$1 = {
 	".": "./src/index.ts",
 	"./alpha": "./src/alpha.ts",
 	"./package.json": "./package.json"
@@ -49,11 +49,11 @@ var scripts = {
 	test: "backstage-cli package test"
 };
 var dependencies = {
-	"@backstage/catalog-model": "workspace:^",
 	"@backstage/core-components": "workspace:^",
 	"@backstage/core-plugin-api": "workspace:^",
 	"@backstage/errors": "workspace:^",
 	"@backstage/frontend-plugin-api": "workspace:^",
+	"@backstage/plugin-catalog-unprocessed-entities-common": "workspace:^",
 	"@material-ui/core": "^4.9.13",
 	"@material-ui/icons": "^4.9.1",
 	"@material-ui/lab": "^4.0.0-alpha.60",
@@ -90,7 +90,7 @@ var _package = {
 	repository: repository,
 	license: license,
 	sideEffects: sideEffects,
-	exports: exports,
+	exports: exports$1,
 	main: main,
 	types: types,
 	typesVersions: typesVersions,
@@ -102,5 +102,5 @@ var _package = {
 	peerDependenciesMeta: peerDependenciesMeta
 };
 
-export { backstage, _package as default, dependencies, devDependencies, exports, files, homepage, license, main, name, peerDependencies, peerDependenciesMeta, publishConfig, repository, scripts, sideEffects, types, typesVersions, version };
+export { backstage, _package as default, dependencies, devDependencies, exports$1 as exports, files, homepage, license, main, name, peerDependencies, peerDependenciesMeta, publishConfig, repository, scripts, sideEffects, types, typesVersions, version };
 //# sourceMappingURL=package.json.esm.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-unprocessed-entities",
-  "version": "0.2.24-next.0",
+  "version": "0.2.24",
   "backstage": {
     "role": "frontend-plugin",
     "pluginId": "catalog-unprocessed-entities",
@@ -62,11 +62,11 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-model": "1.7.6",
-    "@backstage/core-components": "0.18.4-next.0",
-    "@backstage/core-plugin-api": "1.12.1-next.0",
-    "@backstage/errors": "1.2.7",
-    "@backstage/frontend-plugin-api": "0.13.2-next.0",
+    "@backstage/core-components": "^0.18.4",
+    "@backstage/core-plugin-api": "^1.12.1",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/frontend-plugin-api": "^0.13.2",
+    "@backstage/plugin-catalog-unprocessed-entities-common": "^0.0.12",
     "@material-ui/core": "^4.9.13",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "^4.0.0-alpha.60",
@@ -74,8 +74,8 @@
     "react-use": "^17.2.4"
   },
   "devDependencies": {
-    "@backstage/cli": "0.34.6-next.0",
-    "@backstage/dev-utils": "1.1.18-next.0",
+    "@backstage/cli": "^0.35.0",
+    "@backstage/dev-utils": "^1.1.18",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
     "@types/react": "^18.0.0",