@backstage/plugin-catalog-backend-module-bitbucket-cloud 0.0.0-nightly-20220531024457

package/CHANGELOG.md

@@ -0,0 +1,68 @@
+# @backstage/plugin-catalog-backend-module-bitbucket-cloud
+
+## 0.0.0-nightly-20220531024457
+
+### Minor Changes
+
+- dfc4efcbf0: Add new plugin `catalog-backend-module-bitbucket-cloud` with `BitbucketCloudEntityProvider`.
+
+  This entity provider is an alternative/replacement to the `BitbucketDiscoveryProcessor` **_(for Bitbucket Cloud only!)_**.
+  It replaces use cases using `search=true` and should be powerful enough as a complete replacement.
+
+  If any feature for Bitbucket Cloud is missing and preventing you from switching, please raise an issue.
+
+  **Before:**
+
+  ```typescript
+  // packages/backend/src/plugins/catalog.ts
+
+  builder.addProcessor(
+    BitbucketDiscoveryProcessor.fromConfig(env.config, { logger: env.logger }),
+  );
+  ```
+
+  ```yaml
+  # app-config.yaml
+
+  catalog:
+    locations:
+      - type: bitbucket-discovery
+        target: 'https://bitbucket.org/workspaces/workspace-name/projects/apis-*/repos/service-*?search=true&catalogPath=/catalog-info.yaml'
+  ```
+
+  **After:**
+
+  ```typescript
+  // packages/backend/src/plugins/catalog.ts
+  builder.addEntityProvider(
+    BitbucketCloudEntityProvider.fromConfig(env.config, {
+      logger: env.logger,
+      schedule: env.scheduler.createScheduledTaskRunner({
+        frequency: { minutes: 30 },
+        timeout: { minutes: 3 },
+      }),
+    }),
+  );
+  ```
+
+  ```yaml
+  # app-config.yaml
+
+  catalog:
+    providers:
+      bitbucketCloud:
+        yourProviderId: # identifies your ingested dataset
+          catalogPath: /catalog-info.yaml # default value
+          filters: # optional
+            projectKey: '^apis-.* # optional; RegExp
+            repoSlug: '^service-.* # optional; RegExp
+          workspace: workspace-name
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-tasks@0.0.0-nightly-20220531024457
+  - @backstage/integration@0.0.0-nightly-20220531024457
+  - @backstage/plugin-catalog-backend@0.0.0-nightly-20220531024457
+  - @backstage/plugin-bitbucket-cloud-common@0.0.0-nightly-20220531024457

package/README.md

@@ -0,0 +1,9 @@
+# Catalog Backend Module for Bitbucket Cloud
+
+This is an extension module to the catalog-backend plugin,
+providing extensions targeted at Bitbucket Cloud offerings.
+
+## Getting started
+
+See [Backstage documentation](https://backstage.io/docs/integrations/bitbucketCloud/discovery)
+for details on how to install and configure the plugin.

package/config.d.ts

@@ -0,0 +1,90 @@
+/*
+ * 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 interface Config {
+  catalog?: {
+    /**
+     * List of provider-specific options and attributes
+     */
+    providers?: {
+      /**
+       * BitbucketCloudEntityProvider configuration
+       *
+       * Uses "default" as default id for the single config variant.
+       */
+      bitbucketCloud?:
+        | {
+            /**
+             * (Optional) Path to the catalog file. Default to "/catalog-info.yaml".
+             * @visibility frontend
+             */
+            catalogPath?: string;
+            /**
+             * (Required) Your workspace.
+             * @visibility frontend
+             */
+            workspace: string;
+            /**
+             * (Optional) Filters applied to discovered catalog files in repositories.
+             * @visibility frontend
+             */
+            filters?: {
+              /**
+               * (Optional) Filter for the repository slug.
+               * @visibility frontend
+               */
+              repoSlug?: RegExp;
+              /**
+               * (Optional) Filter for the project key.
+               * @visibility frontend
+               */
+              projectKey?: RegExp;
+            };
+          }
+        | Record<
+            string,
+            {
+              /**
+               * (Optional) Path to the catalog file. Default to "/catalog-info.yaml".
+               * @visibility frontend
+               */
+              catalogPath?: string;
+              /**
+               * (Required) Your workspace.
+               * @visibility frontend
+               */
+              workspace: string;
+              /**
+               * (Optional) Filters applied to discovered catalog files in repositories.
+               * @visibility frontend
+               */
+              filters?: {
+                /**
+                 * (Optional) Filter for the repository slug.
+                 * @visibility frontend
+                 */
+                repoSlug?: RegExp;
+                /**
+                 * (Optional) Filter for the project key.
+                 * @visibility frontend
+                 */
+                projectKey?: RegExp;
+              };
+            }
+          >;
+    };
+  };
+}

package/dist/index.cjs.js

@@ -0,0 +1,186 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var integration = require('@backstage/integration');
+var pluginBitbucketCloudCommon = require('@backstage/plugin-bitbucket-cloud-common');
+var pluginCatalogBackend = require('@backstage/plugin-catalog-backend');
+var uuid = require('uuid');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var uuid__namespace = /*#__PURE__*/_interopNamespace(uuid);
+
+const DEFAULT_CATALOG_PATH = "/catalog-info.yaml";
+const DEFAULT_PROVIDER_ID = "default";
+function readProviderConfigs(config) {
+  const providersConfig = config.getOptionalConfig("catalog.providers.bitbucketCloud");
+  if (!providersConfig) {
+    return [];
+  }
+  if (providersConfig.has("workspace")) {
+    return [readProviderConfig(DEFAULT_PROVIDER_ID, providersConfig)];
+  }
+  return providersConfig.keys().map((id) => {
+    const providerConfig = providersConfig.getConfig(id);
+    return readProviderConfig(id, providerConfig);
+  });
+}
+function readProviderConfig(id, config) {
+  var _a;
+  const workspace = config.getString("workspace");
+  const catalogPath = (_a = config.getOptionalString("catalogPath")) != null ? _a : DEFAULT_CATALOG_PATH;
+  const projectKeyPattern = config.getOptionalString("filters.projectKey");
+  const repoSlugPattern = config.getOptionalString("filters.repoSlug");
+  return {
+    id,
+    catalogPath,
+    workspace,
+    filters: {
+      projectKey: projectKeyPattern ? compileRegExp(projectKeyPattern) : void 0,
+      repoSlug: repoSlugPattern ? compileRegExp(repoSlugPattern) : void 0
+    }
+  };
+}
+function compileRegExp(pattern) {
+  let fullLinePattern = pattern;
+  if (!fullLinePattern.startsWith("^")) {
+    fullLinePattern = `^${fullLinePattern}`;
+  }
+  if (!fullLinePattern.endsWith("$")) {
+    fullLinePattern = `${fullLinePattern}$`;
+  }
+  return new RegExp(fullLinePattern);
+}
+
+const DEFAULT_BRANCH = "master";
+class BitbucketCloudEntityProvider {
+  static fromConfig(config, options) {
+    const integrations = integration.ScmIntegrations.fromConfig(config);
+    const integration$1 = integrations.bitbucketCloud.byHost("bitbucket.org");
+    if (!integration$1) {
+      throw new Error("No integration for bitbucket.org available");
+    }
+    return readProviderConfigs(config).map((providerConfig) => new BitbucketCloudEntityProvider(providerConfig, integration$1, options.logger, options.schedule));
+  }
+  constructor(config, integration, logger, schedule) {
+    this.client = pluginBitbucketCloudCommon.BitbucketCloudClient.fromConfig(integration.config);
+    this.config = config;
+    this.logger = logger.child({
+      target: this.getProviderName()
+    });
+    this.scheduleFn = this.createScheduleFn(schedule);
+  }
+  createScheduleFn(schedule) {
+    return async () => {
+      const taskId = this.getTaskId();
+      return schedule.run({
+        id: taskId,
+        fn: async () => {
+          const logger = this.logger.child({
+            class: BitbucketCloudEntityProvider.prototype.constructor.name,
+            taskId,
+            taskInstanceId: uuid__namespace.v4()
+          });
+          try {
+            await this.refresh(logger);
+          } catch (error) {
+            logger.error(error);
+          }
+        }
+      });
+    };
+  }
+  getProviderName() {
+    return `bitbucketCloud-provider:${this.config.id}`;
+  }
+  getTaskId() {
+    return `${this.getProviderName()}:refresh`;
+  }
+  async connect(connection) {
+    this.connection = connection;
+    await this.scheduleFn();
+  }
+  async refresh(logger) {
+    if (!this.connection) {
+      throw new Error("Not initialized");
+    }
+    logger.info("Discovering catalog files in Bitbucket Cloud repositories");
+    const targets = await this.findCatalogFiles();
+    const entities = targets.map(BitbucketCloudEntityProvider.toLocationSpec).map((location) => pluginCatalogBackend.locationSpecToLocationEntity({ location })).map((entity) => {
+      return {
+        locationKey: this.getProviderName(),
+        entity
+      };
+    });
+    await this.connection.applyMutation({
+      type: "full",
+      entities
+    });
+    logger.info(`Committed ${entities.length} Locations for catalog files in Bitbucket Cloud repositories`);
+  }
+  async findCatalogFiles() {
+    const workspace = this.config.workspace;
+    const catalogPath = this.config.catalogPath;
+    const catalogFilename = catalogPath.substring(catalogPath.lastIndexOf("/") + 1);
+    const fields = [
+      "-values.content_matches",
+      "+values.file.commit.repository.mainbranch.name",
+      "+values.file.commit.repository.project.key",
+      "+values.file.commit.repository.slug",
+      "-values.*.links",
+      "-values.*.*.links",
+      "-values.*.*.*.links",
+      "+values.file.commit.repository.links.html.href"
+    ].join(",");
+    const query = `"${catalogFilename}" path:${catalogPath}`;
+    const searchResults = this.client.searchCode(workspace, query, { fields }).iterateResults();
+    const result = [];
+    for await (const searchResult of searchResults) {
+      if (searchResult.path_matches.length === 0) {
+        continue;
+      }
+      const repository = searchResult.file.commit.repository;
+      if (this.matchesFilters(repository)) {
+        result.push(BitbucketCloudEntityProvider.toUrl(repository, searchResult.file.path));
+      }
+    }
+    return result;
+  }
+  matchesFilters(repository) {
+    const filters = this.config.filters;
+    return !filters || (!filters.projectKey || filters.projectKey.test(repository.project.key)) && (!filters.repoSlug || filters.repoSlug.test(repository.slug));
+  }
+  static toUrl(repository, filePath) {
+    var _a, _b;
+    const repoUrl = repository.links.html.href;
+    const branch = (_b = (_a = repository.mainbranch) == null ? void 0 : _a.name) != null ? _b : DEFAULT_BRANCH;
+    return `${repoUrl}/src/${branch}/${filePath}`;
+  }
+  static toLocationSpec(target) {
+    return {
+      type: "url",
+      target,
+      presence: "required"
+    };
+  }
+}
+
+exports.BitbucketCloudEntityProvider = BitbucketCloudEntityProvider;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/BitbucketCloudEntityProviderConfig.ts","../src/BitbucketCloudEntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2022 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 { Config } from '@backstage/config';\n\nconst DEFAULT_CATALOG_PATH = '/catalog-info.yaml';\nconst DEFAULT_PROVIDER_ID = 'default';\n\nexport type BitbucketCloudEntityProviderConfig = {\n  id: string;\n  catalogPath: string;\n  workspace: string;\n  filters?: {\n    projectKey?: RegExp;\n    repoSlug?: RegExp;\n  };\n};\n\nexport function readProviderConfigs(\n  config: Config,\n): BitbucketCloudEntityProviderConfig[] {\n  const providersConfig = config.getOptionalConfig(\n    'catalog.providers.bitbucketCloud',\n  );\n  if (!providersConfig) {\n    return [];\n  }\n\n  if (providersConfig.has('workspace')) {\n    // simple/single config variant\n    return [readProviderConfig(DEFAULT_PROVIDER_ID, providersConfig)];\n  }\n\n  return providersConfig.keys().map(id => {\n    const providerConfig = providersConfig.getConfig(id);\n\n    return readProviderConfig(id, providerConfig);\n  });\n}\n\nfunction readProviderConfig(\n  id: string,\n  config: Config,\n): BitbucketCloudEntityProviderConfig {\n  const workspace = config.getString('workspace');\n  const catalogPath =\n    config.getOptionalString('catalogPath') ?? DEFAULT_CATALOG_PATH;\n  const projectKeyPattern = config.getOptionalString('filters.projectKey');\n  const repoSlugPattern = config.getOptionalString('filters.repoSlug');\n\n  return {\n    id,\n    catalogPath,\n    workspace,\n    filters: {\n      projectKey: projectKeyPattern\n        ? compileRegExp(projectKeyPattern)\n        : undefined,\n      repoSlug: repoSlugPattern ? compileRegExp(repoSlugPattern) : undefined,\n    },\n  };\n}\n\n/**\n * Compiles a RegExp while enforcing the pattern to contain\n * the start-of-line and end-of-line anchors.\n *\n * @param pattern\n */\nfunction compileRegExp(pattern: string): RegExp {\n  let fullLinePattern = pattern;\n  if (!fullLinePattern.startsWith('^')) {\n    fullLinePattern = `^${fullLinePattern}`;\n  }\n  if (!fullLinePattern.endsWith('$')) {\n    fullLinePattern = `${fullLinePattern}$`;\n  }\n\n  return new RegExp(fullLinePattern);\n}\n","/*\n * Copyright 2022 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 { TaskRunner } from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport {\n  BitbucketCloudIntegration,\n  ScmIntegrations,\n} from '@backstage/integration';\nimport {\n  BitbucketCloudClient,\n  Models,\n} from '@backstage/plugin-bitbucket-cloud-common';\nimport {\n  EntityProvider,\n  EntityProviderConnection,\n  LocationSpec,\n  locationSpecToLocationEntity,\n} from '@backstage/plugin-catalog-backend';\nimport {\n  BitbucketCloudEntityProviderConfig,\n  readProviderConfigs,\n} from './BitbucketCloudEntityProviderConfig';\nimport * as uuid from 'uuid';\nimport { Logger } from 'winston';\n\nconst DEFAULT_BRANCH = 'master';\n\n/**\n * Discovers catalog files located in [Bitbucket Cloud](https://bitbucket.org).\n * The provider will search your Bitbucket Cloud account and register catalog files matching the configured path\n * as Location entity and via following processing steps add all contained catalog entities.\n * This can be useful as an alternative to static locations or manually adding things to the catalog.\n *\n * @public\n */\nexport class BitbucketCloudEntityProvider implements EntityProvider {\n  private readonly client: BitbucketCloudClient;\n  private readonly config: BitbucketCloudEntityProviderConfig;\n  private readonly logger: Logger;\n  private readonly scheduleFn: () => Promise<void>;\n  private connection?: EntityProviderConnection;\n\n  static fromConfig(\n    config: Config,\n    options: {\n      logger: Logger;\n      schedule: TaskRunner;\n    },\n  ): BitbucketCloudEntityProvider[] {\n    const integrations = ScmIntegrations.fromConfig(config);\n    const integration = integrations.bitbucketCloud.byHost('bitbucket.org');\n    if (!integration) {\n      // this should never happen as we add a default integration,\n      // but as a general safeguard, e.g. if this approach gets changed\n      throw new Error('No integration for bitbucket.org available');\n    }\n\n    return readProviderConfigs(config).map(\n      providerConfig =>\n        new BitbucketCloudEntityProvider(\n          providerConfig,\n          integration,\n          options.logger,\n          options.schedule,\n        ),\n    );\n  }\n\n  private constructor(\n    config: BitbucketCloudEntityProviderConfig,\n    integration: BitbucketCloudIntegration,\n    logger: Logger,\n    schedule: TaskRunner,\n  ) {\n    this.client = BitbucketCloudClient.fromConfig(integration.config);\n    this.config = config;\n    this.logger = logger.child({\n      target: this.getProviderName(),\n    });\n    this.scheduleFn = this.createScheduleFn(schedule);\n  }\n\n  private createScheduleFn(schedule: TaskRunner): () => Promise<void> {\n    return async () => {\n      const taskId = this.getTaskId();\n      return schedule.run({\n        id: taskId,\n        fn: async () => {\n          const logger = this.logger.child({\n            class: BitbucketCloudEntityProvider.prototype.constructor.name,\n            taskId,\n            taskInstanceId: uuid.v4(),\n          });\n\n          try {\n            await this.refresh(logger);\n          } catch (error) {\n            logger.error(error);\n          }\n        },\n      });\n    };\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */\n  getProviderName(): string {\n    return `bitbucketCloud-provider:${this.config.id}`;\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getTaskId} */\n  getTaskId(): string {\n    return `${this.getProviderName()}:refresh`;\n  }\n\n  /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */\n  async connect(connection: EntityProviderConnection): Promise<void> {\n    this.connection = connection;\n    await this.scheduleFn();\n  }\n\n  async refresh(logger: Logger) {\n    if (!this.connection) {\n      throw new Error('Not initialized');\n    }\n\n    logger.info('Discovering catalog files in Bitbucket Cloud repositories');\n\n    const targets = await this.findCatalogFiles();\n    const entities = targets\n      .map(BitbucketCloudEntityProvider.toLocationSpec)\n      .map(location => locationSpecToLocationEntity({ location }))\n      .map(entity => {\n        return {\n          locationKey: this.getProviderName(),\n          entity: entity,\n        };\n      });\n\n    await this.connection.applyMutation({\n      type: 'full',\n      entities: entities,\n    });\n\n    logger.info(\n      `Committed ${entities.length} Locations for catalog files in Bitbucket Cloud repositories`,\n    );\n  }\n\n  private async findCatalogFiles(): Promise<string[]> {\n    const workspace = this.config.workspace;\n    const catalogPath = this.config.catalogPath;\n\n    const catalogFilename = catalogPath.substring(\n      catalogPath.lastIndexOf('/') + 1,\n    );\n\n    // load all fields relevant for creating refs later, but not more\n    const fields = [\n      // exclude code/content match details\n      '-values.content_matches',\n      // include/add relevant repository details\n      '+values.file.commit.repository.mainbranch.name',\n      '+values.file.commit.repository.project.key',\n      '+values.file.commit.repository.slug',\n      // remove irrelevant links\n      '-values.*.links',\n      '-values.*.*.links',\n      '-values.*.*.*.links',\n      // ...except the one we need\n      '+values.file.commit.repository.links.html.href',\n    ].join(',');\n    const query = `\"${catalogFilename}\" path:${catalogPath}`;\n    const searchResults = this.client\n      .searchCode(workspace, query, { fields })\n      .iterateResults();\n\n    const result: string[] = [];\n\n    for await (const searchResult of searchResults) {\n      // not a file match, but a code match\n      if (searchResult.path_matches!.length === 0) {\n        continue;\n      }\n\n      const repository = searchResult.file!.commit!.repository!;\n      if (this.matchesFilters(repository)) {\n        result.push(\n          BitbucketCloudEntityProvider.toUrl(\n            repository,\n            searchResult.file!.path!,\n          ),\n        );\n      }\n    }\n\n    return result;\n  }\n\n  private matchesFilters(repository: Models.Repository): boolean {\n    const filters = this.config.filters;\n    return (\n      !filters ||\n      ((!filters.projectKey ||\n        filters.projectKey.test(repository.project!.key!)) &&\n        (!filters.repoSlug || filters.repoSlug.test(repository.slug!)))\n    );\n  }\n\n  private static toUrl(\n    repository: Models.Repository,\n    filePath: string,\n  ): string {\n    const repoUrl = repository.links!.html!.href;\n    const branch = repository.mainbranch?.name ?? DEFAULT_BRANCH;\n\n    return `${repoUrl}/src/${branch}/${filePath}`;\n  }\n\n  private static toLocationSpec(target: string): LocationSpec {\n    return {\n      type: 'url',\n      target: target,\n      presence: 'required',\n    };\n  }\n}\n"],"names":["ScmIntegrations","integration","BitbucketCloudClient","uuid","locationSpecToLocationEntity"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AAClD,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAC/B,SAAS,mBAAmB,CAAC,MAAM,EAAE;AAC5C,EAAE,MAAM,eAAe,GAAG,MAAM,CAAC,iBAAiB,CAAC,kCAAkC,CAAC,CAAC;AACvF,EAAE,IAAI,CAAC,eAAe,EAAE;AACxB,IAAI,OAAO,EAAE,CAAC;AACd,GAAG;AACH,EAAE,IAAI,eAAe,CAAC,GAAG,CAAC,WAAW,CAAC,EAAE;AACxC,IAAI,OAAO,CAAC,kBAAkB,CAAC,mBAAmB,EAAE,eAAe,CAAC,CAAC,CAAC;AACtE,GAAG;AACH,EAAE,OAAO,eAAe,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK;AAC5C,IAAI,MAAM,cAAc,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;AACzD,IAAI,OAAO,kBAAkB,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;AAClD,GAAG,CAAC,CAAC;AACL,CAAC;AACD,SAAS,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE;AACxC,EAAE,IAAI,EAAE,CAAC;AACT,EAAE,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;AAClD,EAAE,MAAM,WAAW,GAAG,CAAC,EAAE,GAAG,MAAM,CAAC,iBAAiB,CAAC,aAAa,CAAC,KAAK,IAAI,GAAG,EAAE,GAAG,oBAAoB,CAAC;AACzG,EAAE,MAAM,iBAAiB,GAAG,MAAM,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC;AAC3E,EAAE,MAAM,eAAe,GAAG,MAAM,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;AACvE,EAAE,OAAO;AACT,IAAI,EAAE;AACN,IAAI,WAAW;AACf,IAAI,SAAS;AACb,IAAI,OAAO,EAAE;AACb,MAAM,UAAU,EAAE,iBAAiB,GAAG,aAAa,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC;AAC/E,MAAM,QAAQ,EAAE,eAAe,GAAG,aAAa,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC;AACzE,KAAK;AACL,GAAG,CAAC;AACJ,CAAC;AACD,SAAS,aAAa,CAAC,OAAO,EAAE;AAChC,EAAE,IAAI,eAAe,GAAG,OAAO,CAAC;AAChC,EAAE,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;AACxC,IAAI,eAAe,GAAG,CAAC,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC;AAC5C,GAAG;AACH,EAAE,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;AACtC,IAAI,eAAe,GAAG,CAAC,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;AAC5C,GAAG;AACH,EAAE,OAAO,IAAI,MAAM,CAAC,eAAe,CAAC,CAAC;AACrC;;AC3BA,MAAM,cAAc,GAAG,QAAQ,CAAC;AACzB,MAAM,4BAA4B,CAAC;AAC1C,EAAE,OAAO,UAAU,CAAC,MAAM,EAAE,OAAO,EAAE;AACrC,IAAI,MAAM,YAAY,GAAGA,2BAAe,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;AAC5D,IAAI,MAAMC,aAAW,GAAG,YAAY,CAAC,cAAc,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;AAC5E,IAAI,IAAI,CAACA,aAAW,EAAE;AACtB,MAAM,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;AACpE,KAAK;AACL,IAAI,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,cAAc,KAAK,IAAI,4BAA4B,CAAC,cAAc,EAAEA,aAAW,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;AAChK,GAAG;AACH,EAAE,WAAW,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE;AACrD,IAAI,IAAI,CAAC,MAAM,GAAGC,+CAAoB,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;AACtE,IAAI,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;AACzB,IAAI,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC;AAC/B,MAAM,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE;AACpC,KAAK,CAAC,CAAC;AACP,IAAI,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC;AACtD,GAAG;AACH,EAAE,gBAAgB,CAAC,QAAQ,EAAE;AAC7B,IAAI,OAAO,YAAY;AACvB,MAAM,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;AACtC,MAAM,OAAO,QAAQ,CAAC,GAAG,CAAC;AAC1B,QAAQ,EAAE,EAAE,MAAM;AAClB,QAAQ,EAAE,EAAE,YAAY;AACxB,UAAU,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;AAC3C,YAAY,KAAK,EAAE,4BAA4B,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI;AAC1E,YAAY,MAAM;AAClB,YAAY,cAAc,EAAEC,eAAI,CAAC,EAAE,EAAE;AACrC,WAAW,CAAC,CAAC;AACb,UAAU,IAAI;AACd,YAAY,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACvC,WAAW,CAAC,OAAO,KAAK,EAAE;AAC1B,YAAY,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAChC,WAAW;AACX,SAAS;AACT,OAAO,CAAC,CAAC;AACT,KAAK,CAAC;AACN,GAAG;AACH,EAAE,eAAe,GAAG;AACpB,IAAI,OAAO,CAAC,wBAAwB,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;AACvD,GAAG;AACH,EAAE,SAAS,GAAG;AACd,IAAI,OAAO,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,CAAC,QAAQ,CAAC,CAAC;AAC/C,GAAG;AACH,EAAE,MAAM,OAAO,CAAC,UAAU,EAAE;AAC5B,IAAI,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;AACjC,IAAI,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;AAC5B,GAAG;AACH,EAAE,MAAM,OAAO,CAAC,MAAM,EAAE;AACxB,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;AAC1B,MAAM,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;AACzC,KAAK;AACL,IAAI,MAAM,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAC;AAC7E,IAAI,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;AAClD,IAAI,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,KAAKC,iDAA4B,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK;AAC5J,MAAM,OAAO;AACb,QAAQ,WAAW,EAAE,IAAI,CAAC,eAAe,EAAE;AAC3C,QAAQ,MAAM;AACd,OAAO,CAAC;AACR,KAAK,CAAC,CAAC;AACP,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;AACxC,MAAM,IAAI,EAAE,MAAM;AAClB,MAAM,QAAQ;AACd,KAAK,CAAC,CAAC;AACP,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,4DAA4D,CAAC,CAAC,CAAC;AAC5G,GAAG;AACH,EAAE,MAAM,gBAAgB,GAAG;AAC3B,IAAI,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;AAC5C,IAAI,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;AAChD,IAAI,MAAM,eAAe,GAAG,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;AACpF,IAAI,MAAM,MAAM,GAAG;AACnB,MAAM,yBAAyB;AAC/B,MAAM,gDAAgD;AACtD,MAAM,4CAA4C;AAClD,MAAM,qCAAqC;AAC3C,MAAM,iBAAiB;AACvB,MAAM,mBAAmB;AACzB,MAAM,qBAAqB;AAC3B,MAAM,gDAAgD;AACtD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAChB,IAAI,MAAM,KAAK,GAAG,CAAC,CAAC,EAAE,eAAe,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;AAC7D,IAAI,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,cAAc,EAAE,CAAC;AAChG,IAAI,MAAM,MAAM,GAAG,EAAE,CAAC;AACtB,IAAI,WAAW,MAAM,YAAY,IAAI,aAAa,EAAE;AACpD,MAAM,IAAI,YAAY,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE;AAClD,QAAQ,SAAS;AACjB,OAAO;AACP,MAAM,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;AAC7D,MAAM,IAAI,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE;AAC3C,QAAQ,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,KAAK,CAAC,UAAU,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC5F,OAAO;AACP,KAAK;AACL,IAAI,OAAO,MAAM,CAAC;AAClB,GAAG;AACH,EAAE,cAAc,CAAC,UAAU,EAAE;AAC7B,IAAI,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;AACxC,IAAI,OAAO,CAAC,OAAO,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;AACjK,GAAG;AACH,EAAE,OAAO,KAAK,CAAC,UAAU,EAAE,QAAQ,EAAE;AACrC,IAAI,IAAI,EAAE,EAAE,EAAE,CAAC;AACf,IAAI,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;AAC/C,IAAI,MAAM,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,UAAU,CAAC,UAAU,KAAK,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,KAAK,IAAI,GAAG,EAAE,GAAG,cAAc,CAAC;AAChH,IAAI,OAAO,CAAC,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;AAClD,GAAG;AACH,EAAE,OAAO,cAAc,CAAC,MAAM,EAAE;AAChC,IAAI,OAAO;AACX,MAAM,IAAI,EAAE,KAAK;AACjB,MAAM,MAAM;AACZ,MAAM,QAAQ,EAAE,UAAU;AAC1B,KAAK,CAAC;AACN,GAAG;AACH;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import { TaskRunner } from '@backstage/backend-tasks';
+import { Config } from '@backstage/config';
+import { EntityProvider, EntityProviderConnection } from '@backstage/plugin-catalog-backend';
+import { Logger } from 'winston';
+
+/**
+ * Discovers catalog files located in [Bitbucket Cloud](https://bitbucket.org).
+ * The provider will search your Bitbucket Cloud account and register catalog files matching the configured path
+ * as Location entity and via following processing steps add all contained catalog entities.
+ * This can be useful as an alternative to static locations or manually adding things to the catalog.
+ *
+ * @public
+ */
+declare class BitbucketCloudEntityProvider implements EntityProvider {
+    private readonly client;
+    private readonly config;
+    private readonly logger;
+    private readonly scheduleFn;
+    private connection?;
+    static fromConfig(config: Config, options: {
+        logger: Logger;
+        schedule: TaskRunner;
+    }): BitbucketCloudEntityProvider[];
+    private constructor();
+    private createScheduleFn;
+    /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getProviderName} */
+    getProviderName(): string;
+    /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.getTaskId} */
+    getTaskId(): string;
+    /** {@inheritdoc @backstage/plugin-catalog-backend#EntityProvider.connect} */
+    connect(connection: EntityProviderConnection): Promise<void>;
+    refresh(logger: Logger): Promise<void>;
+    private findCatalogFiles;
+    private matchesFilters;
+    private static toUrl;
+    private static toLocationSpec;
+}
+
+export { BitbucketCloudEntityProvider };

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@backstage/plugin-catalog-backend-module-bitbucket-cloud",
+  "description": "A Backstage catalog backend module that helps integrate towards Bitbucket Cloud",
+  "version": "0.0.0-nightly-20220531024457",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "private": false,
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "homepage": "https://backstage.io",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/backstage/backstage",
+    "directory": "plugins/catalog-backend-module-bitbucket-cloud"
+  },
+  "keywords": [
+    "backstage"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack",
+    "clean": "backstage-cli package clean",
+    "start": "backstage-cli package start"
+  },
+  "dependencies": {
+    "@backstage/backend-tasks": "^0.0.0-nightly-20220531024457",
+    "@backstage/config": "^1.0.1",
+    "@backstage/integration": "^0.0.0-nightly-20220531024457",
+    "@backstage/plugin-bitbucket-cloud-common": "^0.0.0-nightly-20220531024457",
+    "@backstage/plugin-catalog-backend": "^0.0.0-nightly-20220531024457",
+    "uuid": "^8.0.0",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/backend-common": "^0.0.0-nightly-20220531024457",
+    "@backstage/backend-test-utils": "^0.0.0-nightly-20220531024457",
+    "@backstage/cli": "^0.0.0-nightly-20220531024457",
+    "msw": "^0.35.0"
+  },
+  "files": [
+    "dist",
+    "config.d.ts"
+  ],
+  "configSchema": "config.d.ts"
+}