@backstage/plugin-catalog-unprocessed-entities-common 0.0.11-next.0 → 0.0.12-next.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @backstage/plugin-catalog-unprocessed-entities-common
 
+## 0.0.12-next.0
+
+### 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.
+
+## 0.0.11
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-permission-common@0.9.3
+
 ## 0.0.11-next.0
 
 ### Patch Changes

package/dist/api/api.cjs.js

@@ -0,0 +1,41 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+
+class CatalogUnprocessedEntitiesClient {
+  discovery;
+  fetchApi;
+  constructor(discovery, fetchApi) {
+    this.discovery = discovery;
+    this.fetchApi = fetchApi ?? { fetch };
+  }
+  async fetch(method, path, options) {
+    const url = await this.discovery.getBaseUrl("catalog");
+    const resp = await this.fetchApi.fetch(`${url}/${path}`, {
+      method,
+      headers: {
+        ...options?.token ? { Authorization: `Bearer ${options.token}` } : {}
+      }
+    });
+    if (!resp.ok) {
+      throw await errors.ResponseError.fromResponse(resp);
+    }
+    return resp.status === 204 ? resp : await resp.json();
+  }
+  async pending(options) {
+    return await this.fetch("GET", "entities/unprocessed/pending", options);
+  }
+  async failed(options) {
+    return await this.fetch("GET", "entities/unprocessed/failed", options);
+  }
+  async delete(entityId, options) {
+    await this.fetch(
+      "DELETE",
+      `entities/unprocessed/delete/${entityId}`,
+      options
+    );
+  }
+}
+
+exports.CatalogUnprocessedEntitiesClient = CatalogUnprocessedEntitiesClient;
+//# sourceMappingURL=api.cjs.js.map

package/dist/api/api.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.cjs.js","sources":["../../src/api/api.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 */\n\nimport { CatalogUnprocessedEntitiesApiResponse } from '../types';\nimport { ResponseError } from '@backstage/errors';\n\n/**\n * Options you can pass into a catalog request for additional information.\n *\n * @public\n */\nexport interface UnprocessedEntitiesRequestOptions {\n  token?: string;\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   * @param options - Additional options\n   */\n  pending(\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<CatalogUnprocessedEntitiesApiResponse>;\n  /**\n   * Returns a list of entities with state 'failed'\n   *\n   * @param options - Additional options\n   */\n  failed(\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<CatalogUnprocessedEntitiesApiResponse>;\n  /**\n   * Deletes an entity from the refresh_state table\n   *\n   * @param entityId - The ID of the entity to delete\n   * @param options - Additional options\n   */\n  delete(\n    entityId: string,\n    options?: UnprocessedEntitiesRequestOptions,\n  ): 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  private readonly discovery: { getBaseUrl(pluginId: string): Promise<string> };\n  private readonly fetchApi: { fetch: typeof fetch };\n\n  constructor(\n    discovery: { getBaseUrl(pluginId: string): Promise<string> },\n    fetchApi?: { fetch: typeof fetch },\n  ) {\n    this.discovery = discovery;\n    this.fetchApi = fetchApi ?? { fetch };\n  }\n\n  private async fetch<T>(\n    method: string,\n    path: string,\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<T> {\n    const url = await this.discovery.getBaseUrl('catalog');\n    const resp = await this.fetchApi.fetch(`${url}/${path}`, {\n      method,\n      headers: {\n        ...(options?.token ? { Authorization: `Bearer ${options.token}` } : {}),\n      },\n    });\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(\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<CatalogUnprocessedEntitiesApiResponse> {\n    return await this.fetch('GET', 'entities/unprocessed/pending', options);\n  }\n\n  async failed(\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<CatalogUnprocessedEntitiesApiResponse> {\n    return await this.fetch('GET', 'entities/unprocessed/failed', options);\n  }\n\n  async delete(\n    entityId: string,\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<void> {\n    await this.fetch(\n      'DELETE',\n      `entities/unprocessed/delete/${entityId}`,\n      options,\n    );\n  }\n}\n"],"names":["ResponseError"],"mappings":";;;;AAmEO,MAAM,gCAAA,CAEb;AAAA,EACmB,SAAA;AAAA,EACA,QAAA;AAAA,EAEjB,WAAA,CACE,WACA,QAAA,EACA;AACA,IAAA,IAAA,CAAK,SAAA,GAAY,SAAA;AACjB,IAAA,IAAA,CAAK,QAAA,GAAW,QAAA,IAAY,EAAE,KAAA,EAAM;AAAA,EACtC;AAAA,EAEA,MAAc,KAAA,CACZ,MAAA,EACA,IAAA,EACA,OAAA,EACY;AACZ,IAAA,MAAM,GAAA,GAAM,MAAM,IAAA,CAAK,SAAA,CAAU,WAAW,SAAS,CAAA;AACrD,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,QAAA,CAAS,MAAM,CAAA,EAAG,GAAG,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI;AAAA,MACvD,MAAA;AAAA,MACA,OAAA,EAAS;AAAA,QACP,GAAI,OAAA,EAAS,KAAA,GAAQ,EAAE,aAAA,EAAe,UAAU,OAAA,CAAQ,KAAK,CAAA,CAAA,EAAG,GAAI;AAAC;AACvE,KACD,CAAA;AAED,IAAA,IAAI,CAAC,KAAK,EAAA,EAAI;AACZ,MAAA,MAAM,MAAMA,oBAAA,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,QACJ,OAAA,EACgD;AAChD,IAAA,OAAO,MAAM,IAAA,CAAK,KAAA,CAAM,KAAA,EAAO,gCAAgC,OAAO,CAAA;AAAA,EACxE;AAAA,EAEA,MAAM,OACJ,OAAA,EACgD;AAChD,IAAA,OAAO,MAAM,IAAA,CAAK,KAAA,CAAM,KAAA,EAAO,+BAA+B,OAAO,CAAA;AAAA,EACvE;AAAA,EAEA,MAAM,MAAA,CACJ,QAAA,EACA,OAAA,EACe;AACf,IAAA,MAAM,IAAA,CAAK,KAAA;AAAA,MACT,QAAA;AAAA,MACA,+BAA+B,QAAQ,CAAA,CAAA;AAAA,MACvC;AAAA,KACF;AAAA,EACF;AACF;;;;"}

package/dist/api/api.esm.js

@@ -0,0 +1,39 @@
+import { ResponseError } from '@backstage/errors';
+
+class CatalogUnprocessedEntitiesClient {
+  discovery;
+  fetchApi;
+  constructor(discovery, fetchApi) {
+    this.discovery = discovery;
+    this.fetchApi = fetchApi ?? { fetch };
+  }
+  async fetch(method, path, options) {
+    const url = await this.discovery.getBaseUrl("catalog");
+    const resp = await this.fetchApi.fetch(`${url}/${path}`, {
+      method,
+      headers: {
+        ...options?.token ? { Authorization: `Bearer ${options.token}` } : {}
+      }
+    });
+    if (!resp.ok) {
+      throw await ResponseError.fromResponse(resp);
+    }
+    return resp.status === 204 ? resp : await resp.json();
+  }
+  async pending(options) {
+    return await this.fetch("GET", "entities/unprocessed/pending", options);
+  }
+  async failed(options) {
+    return await this.fetch("GET", "entities/unprocessed/failed", options);
+  }
+  async delete(entityId, options) {
+    await this.fetch(
+      "DELETE",
+      `entities/unprocessed/delete/${entityId}`,
+      options
+    );
+  }
+}
+
+export { CatalogUnprocessedEntitiesClient };
+//# sourceMappingURL=api.esm.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api.esm.js","sources":["../../src/api/api.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 */\n\nimport { CatalogUnprocessedEntitiesApiResponse } from '../types';\nimport { ResponseError } from '@backstage/errors';\n\n/**\n * Options you can pass into a catalog request for additional information.\n *\n * @public\n */\nexport interface UnprocessedEntitiesRequestOptions {\n  token?: string;\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   * @param options - Additional options\n   */\n  pending(\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<CatalogUnprocessedEntitiesApiResponse>;\n  /**\n   * Returns a list of entities with state 'failed'\n   *\n   * @param options - Additional options\n   */\n  failed(\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<CatalogUnprocessedEntitiesApiResponse>;\n  /**\n   * Deletes an entity from the refresh_state table\n   *\n   * @param entityId - The ID of the entity to delete\n   * @param options - Additional options\n   */\n  delete(\n    entityId: string,\n    options?: UnprocessedEntitiesRequestOptions,\n  ): 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  private readonly discovery: { getBaseUrl(pluginId: string): Promise<string> };\n  private readonly fetchApi: { fetch: typeof fetch };\n\n  constructor(\n    discovery: { getBaseUrl(pluginId: string): Promise<string> },\n    fetchApi?: { fetch: typeof fetch },\n  ) {\n    this.discovery = discovery;\n    this.fetchApi = fetchApi ?? { fetch };\n  }\n\n  private async fetch<T>(\n    method: string,\n    path: string,\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<T> {\n    const url = await this.discovery.getBaseUrl('catalog');\n    const resp = await this.fetchApi.fetch(`${url}/${path}`, {\n      method,\n      headers: {\n        ...(options?.token ? { Authorization: `Bearer ${options.token}` } : {}),\n      },\n    });\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(\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<CatalogUnprocessedEntitiesApiResponse> {\n    return await this.fetch('GET', 'entities/unprocessed/pending', options);\n  }\n\n  async failed(\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<CatalogUnprocessedEntitiesApiResponse> {\n    return await this.fetch('GET', 'entities/unprocessed/failed', options);\n  }\n\n  async delete(\n    entityId: string,\n    options?: UnprocessedEntitiesRequestOptions,\n  ): Promise<void> {\n    await this.fetch(\n      'DELETE',\n      `entities/unprocessed/delete/${entityId}`,\n      options,\n    );\n  }\n}\n"],"names":[],"mappings":";;AAmEO,MAAM,gCAAA,CAEb;AAAA,EACmB,SAAA;AAAA,EACA,QAAA;AAAA,EAEjB,WAAA,CACE,WACA,QAAA,EACA;AACA,IAAA,IAAA,CAAK,SAAA,GAAY,SAAA;AACjB,IAAA,IAAA,CAAK,QAAA,GAAW,QAAA,IAAY,EAAE,KAAA,EAAM;AAAA,EACtC;AAAA,EAEA,MAAc,KAAA,CACZ,MAAA,EACA,IAAA,EACA,OAAA,EACY;AACZ,IAAA,MAAM,GAAA,GAAM,MAAM,IAAA,CAAK,SAAA,CAAU,WAAW,SAAS,CAAA;AACrD,IAAA,MAAM,IAAA,GAAO,MAAM,IAAA,CAAK,QAAA,CAAS,MAAM,CAAA,EAAG,GAAG,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,EAAI;AAAA,MACvD,MAAA;AAAA,MACA,OAAA,EAAS;AAAA,QACP,GAAI,OAAA,EAAS,KAAA,GAAQ,EAAE,aAAA,EAAe,UAAU,OAAA,CAAQ,KAAK,CAAA,CAAA,EAAG,GAAI;AAAC;AACvE,KACD,CAAA;AAED,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,QACJ,OAAA,EACgD;AAChD,IAAA,OAAO,MAAM,IAAA,CAAK,KAAA,CAAM,KAAA,EAAO,gCAAgC,OAAO,CAAA;AAAA,EACxE;AAAA,EAEA,MAAM,OACJ,OAAA,EACgD;AAChD,IAAA,OAAO,MAAM,IAAA,CAAK,KAAA,CAAM,KAAA,EAAO,+BAA+B,OAAO,CAAA;AAAA,EACvE;AAAA,EAEA,MAAM,MAAA,CACJ,QAAA,EACA,OAAA,EACe;AACf,IAAA,MAAM,IAAA,CAAK,KAAA;AAAA,MACT,QAAA;AAAA,MACA,+BAA+B,QAAQ,CAAA,CAAA;AAAA,MACvC;AAAA,KACF;AAAA,EACF;AACF;;;;"}

package/dist/index.cjs.js

@@ -1,9 +1,11 @@
 'use strict';
 
+var api = require('./api/api.cjs.js');
 var permissions = require('./permissions.cjs.js');
 
 
 
+exports.CatalogUnprocessedEntitiesClient = api.CatalogUnprocessedEntitiesClient;
 exports.unprocessedEntitiesDeletePermission = permissions.unprocessedEntitiesDeletePermission;
 exports.unprocessedEntitiesPermissions = permissions.unprocessedEntitiesPermissions;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;"}

package/dist/index.d.ts

@@ -1,5 +1,106 @@
+import { Entity } from '@backstage/catalog-model';
 import * as _backstage_plugin_permission_common from '@backstage/plugin-permission-common';
 
+/**
+ * Unprocessed entity data stored in the database.
+ * @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;
+};
+/**
+ * Unprocessed entity cache stored in the database.
+ * @public
+ */
+type UnprocessedEntityCache = {
+    ttl: number;
+    cache: object;
+};
+/**
+ * Unprocessed entity error information stored in the database.
+ * @public
+ */
+type UnprocessedEntityError = {
+    name: string;
+    message: string;
+    cause: {
+        name: string;
+        message: string;
+        stack: string;
+    };
+};
+/**
+ * Response expected by the {@link CatalogUnprocessedEntitiesApi}
+ *
+ * @public
+ */
+type CatalogUnprocessedEntitiesApiResponse = {
+    entities: UnprocessedEntity[];
+};
+
+/**
+ * Options you can pass into a catalog request for additional information.
+ *
+ * @public
+ */
+interface UnprocessedEntitiesRequestOptions {
+    token?: string;
+}
+/**
+ * Interface for the CatalogUnprocessedEntitiesApi.
+ *
+ * @public
+ */
+interface CatalogUnprocessedEntitiesApi {
+    /**
+     * Returns a list of entities with state 'pending'
+     *
+     * @param options - Additional options
+     */
+    pending(options?: UnprocessedEntitiesRequestOptions): Promise<CatalogUnprocessedEntitiesApiResponse>;
+    /**
+     * Returns a list of entities with state 'failed'
+     *
+     * @param options - Additional options
+     */
+    failed(options?: UnprocessedEntitiesRequestOptions): Promise<CatalogUnprocessedEntitiesApiResponse>;
+    /**
+     * Deletes an entity from the refresh_state table
+     *
+     * @param entityId - The ID of the entity to delete
+     * @param options - Additional options
+     */
+    delete(entityId: string, options?: UnprocessedEntitiesRequestOptions): Promise<void>;
+}
+/**
+ * Default API implementation for the Catalog Unprocessed Entities plugin
+ *
+ * @public
+ */
+declare class CatalogUnprocessedEntitiesClient implements CatalogUnprocessedEntitiesApi {
+    private readonly discovery;
+    private readonly fetchApi;
+    constructor(discovery: {
+        getBaseUrl(pluginId: string): Promise<string>;
+    }, fetchApi?: {
+        fetch: typeof fetch;
+    });
+    private fetch;
+    pending(options?: UnprocessedEntitiesRequestOptions): Promise<CatalogUnprocessedEntitiesApiResponse>;
+    failed(options?: UnprocessedEntitiesRequestOptions): Promise<CatalogUnprocessedEntitiesApiResponse>;
+    delete(entityId: string, options?: UnprocessedEntitiesRequestOptions): Promise<void>;
+}
+
 /**
  * This permission is used to designate actions that involve removing an
  * unprocessed entity record from the refresh_state table.
@@ -14,4 +115,4 @@ declare const unprocessedEntitiesPermissions: {
     unprocessedEntitiesDeletePermission: _backstage_plugin_permission_common.BasicPermission;
 };
 
-export { unprocessedEntitiesDeletePermission, unprocessedEntitiesPermissions };
+export { type CatalogUnprocessedEntitiesApi, type CatalogUnprocessedEntitiesApiResponse, CatalogUnprocessedEntitiesClient, type UnprocessedEntitiesRequestOptions, type UnprocessedEntity, type UnprocessedEntityCache, type UnprocessedEntityError, unprocessedEntitiesDeletePermission, unprocessedEntitiesPermissions };

package/dist/index.esm.js

@@ -1,2 +1,3 @@
+export { CatalogUnprocessedEntitiesClient } from './api/api.esm.js';
 export { unprocessedEntitiesDeletePermission, unprocessedEntitiesPermissions } from './permissions.esm.js';
 //# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":""}
+{"version":3,"file":"index.esm.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-unprocessed-entities-common",
-  "version": "0.0.11-next.0",
+  "version": "0.0.12-next.0",
   "description": "Common functionalities for the catalog-unprocessed-entities plugin",
   "backstage": {
     "role": "common-library",
@@ -37,10 +37,12 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/plugin-permission-common": "0.9.3-next.0"
+    "@backstage/catalog-model": "1.7.6",
+    "@backstage/errors": "1.2.7",
+    "@backstage/plugin-permission-common": "0.9.3"
   },
   "devDependencies": {
-    "@backstage/cli": "0.34.5-next.0"
+    "@backstage/cli": "0.34.6-next.1"
   },
   "typesVersions": {
     "*": {