@backstage/plugin-catalog-backend-module-bitbucket-cloud 0.1.4-next.1 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # @backstage/plugin-catalog-backend-module-bitbucket-cloud
 
+## 0.1.4
+
+### Patch Changes
+
+- f66e696e7b: Bitbucket Cloud provider: Add option to configure schedule via `app-config.yaml` instead of in code.
+
+  Please find how to configure the schedule at the config at
+  https://backstage.io/docs/integrations/bitbucketCloud/discovery
+
+- a9b91d39bb: Add `bitbucketCloudCatalogModule` (new backend-plugin-api, alpha).
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.2.0
+  - @backstage/plugin-catalog-backend@1.5.0
+  - @backstage/backend-tasks@0.3.6
+  - @backstage/backend-plugin-api@0.1.3
+  - @backstage/plugin-bitbucket-cloud-common@0.2.0
+  - @backstage/config@1.0.3
+  - @backstage/integration@1.3.2
+
+## 0.1.4-next.2
+
+### Patch Changes
+
+- f66e696e7b: Bitbucket Cloud provider: Add option to configure schedule via `app-config.yaml` instead of in code.
+
+  Please find how to configure the schedule at the config at
+  https://backstage.io/docs/integrations/bitbucketCloud/discovery
+
+- a9b91d39bb: Add `bitbucketCloudCatalogModule` (new backend-plugin-api, alpha).
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.2.0-next.2
+  - @backstage/plugin-catalog-backend@1.5.0-next.2
+  - @backstage/backend-tasks@0.3.6-next.2
+  - @backstage/backend-plugin-api@0.1.3-next.2
+  - @backstage/config@1.0.3-next.2
+  - @backstage/integration@1.3.2-next.2
+  - @backstage/plugin-bitbucket-cloud-common@0.2.0-next.2
+
 ## 0.1.4-next.1
 
 ### Patch Changes

package/alpha/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@backstage/plugin-catalog-backend-module-bitbucket-cloud",
+  "version": "0.1.4",
+  "main": "../dist/index.cjs.js",
+  "types": "../dist/index.alpha.d.ts"
+}

package/config.d.ts

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import { TaskScheduleDefinitionConfig } from '@backstage/backend-tasks';
+
 export interface Config {
   catalog?: {
     /**
@@ -53,6 +55,10 @@ export interface Config {
                */
               projectKey?: RegExp;
             };
+            /**
+             * (Optional) TaskScheduleDefinition for the discovery.
+             */
+            schedule?: TaskScheduleDefinitionConfig;
           }
         | Record<
             string,
@@ -83,6 +89,10 @@ export interface Config {
                  */
                 projectKey?: RegExp;
               };
+              /**
+               * (Optional) TaskScheduleDefinition for the discovery.
+               */
+              schedule?: TaskScheduleDefinitionConfig;
             }
           >;
     };

package/dist/index.alpha.d.ts

@@ -0,0 +1,54 @@
+/**
+ * A Backstage catalog backend module that helps integrate towards Bitbucket Cloud
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { Config } from '@backstage/config';
+import { EntityProvider } from '@backstage/plugin-catalog-backend';
+import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
+import { Logger } from 'winston';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
+import { TaskRunner } from '@backstage/backend-tasks';
+
+/**
+ * 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
+ */
+export 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;
+        scheduler?: PluginTaskScheduler;
+    }): 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;
+}
+
+/**
+ * @alpha
+ */
+export declare const bitbucketCloudEntityProviderCatalogModule: (options?: undefined) => BackendFeature;
+
+export { }

package/dist/index.beta.d.ts

@@ -0,0 +1,51 @@
+/**
+ * A Backstage catalog backend module that helps integrate towards Bitbucket Cloud
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
+import { Config } from '@backstage/config';
+import { EntityProvider } from '@backstage/plugin-catalog-backend';
+import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
+import { Logger } from 'winston';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
+import { TaskRunner } from '@backstage/backend-tasks';
+
+/**
+ * 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
+ */
+export 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;
+        scheduler?: PluginTaskScheduler;
+    }): 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;
+}
+
+/* Excluded from this release type: bitbucketCloudEntityProviderCatalogModule */
+
+export { }

package/dist/index.cjs.js

@@ -5,7 +5,10 @@ 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 backendTasks = require('@backstage/backend-tasks');
 var uuid = require('uuid');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var pluginCatalogNode = require('@backstage/plugin-catalog-node');
 
 function _interopNamespace(e) {
   if (e && e.__esModule) return e;
@@ -50,6 +53,7 @@ function readProviderConfig(id, config) {
   const catalogPath = (_a = config.getOptionalString("catalogPath")) != null ? _a : DEFAULT_CATALOG_PATH;
   const projectKeyPattern = config.getOptionalString("filters.projectKey");
   const repoSlugPattern = config.getOptionalString("filters.repoSlug");
+  const schedule = config.has("schedule") ? backendTasks.readTaskScheduleDefinitionFromConfig(config.getConfig("schedule")) : void 0;
   return {
     id,
     catalogPath,
@@ -57,7 +61,8 @@ function readProviderConfig(id, config) {
     filters: {
       projectKey: projectKeyPattern ? compileRegExp(projectKeyPattern) : void 0,
       repoSlug: repoSlugPattern ? compileRegExp(repoSlugPattern) : void 0
-    }
+    },
+    schedule
   };
 }
 function compileRegExp(pattern) {
@@ -79,22 +84,32 @@ class BitbucketCloudEntityProvider {
     if (!integration$1) {
       throw new Error("No integration for bitbucket.org available");
     }
-    return readProviderConfigs(config).map(
-      (providerConfig) => new BitbucketCloudEntityProvider(
+    if (!options.schedule && !options.scheduler) {
+      throw new Error("Either schedule or scheduler must be provided.");
+    }
+    return readProviderConfigs(config).map((providerConfig) => {
+      var _a;
+      if (!options.schedule && !providerConfig.schedule) {
+        throw new Error(
+          `No schedule provided neither via code nor config for bitbucketCloud-provider:${providerConfig.id}.`
+        );
+      }
+      const taskRunner = (_a = options.schedule) != null ? _a : options.scheduler.createScheduledTaskRunner(providerConfig.schedule);
+      return new BitbucketCloudEntityProvider(
         providerConfig,
         integration$1,
         options.logger,
-        options.schedule
-      )
-    );
+        taskRunner
+      );
+    });
   }
-  constructor(config, integration, logger, schedule) {
+  constructor(config, integration, logger, taskRunner) {
     this.client = pluginBitbucketCloudCommon.BitbucketCloudClient.fromConfig(integration.config);
     this.config = config;
     this.logger = logger.child({
       target: this.getProviderName()
     });
-    this.scheduleFn = this.createScheduleFn(schedule);
+    this.scheduleFn = this.createScheduleFn(taskRunner);
   }
   createScheduleFn(schedule) {
     return async () => {
@@ -200,5 +215,29 @@ class BitbucketCloudEntityProvider {
   }
 }
 
+const bitbucketCloudEntityProviderCatalogModule = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "bitbucketCloudEntityProvider",
+  register(env) {
+    env.registerInit({
+      deps: {
+        catalog: pluginCatalogNode.catalogProcessingExtensionPoint,
+        config: backendPluginApi.configServiceRef,
+        logger: backendPluginApi.loggerServiceRef,
+        scheduler: backendPluginApi.schedulerServiceRef
+      },
+      async init({ catalog, config, logger, scheduler }) {
+        const winstonLogger = backendPluginApi.loggerToWinstonLogger(logger);
+        const providers = BitbucketCloudEntityProvider.fromConfig(config, {
+          logger: winstonLogger,
+          scheduler
+        });
+        catalog.addEntityProvider(providers);
+      }
+    });
+  }
+});
+
 exports.BitbucketCloudEntityProvider = BitbucketCloudEntityProvider;
+exports.bitbucketCloudEntityProviderCatalogModule = bitbucketCloudEntityProviderCatalogModule;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +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":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkBA,MAAM,oBAAuB,GAAA,oBAAA,CAAA;AAC7B,MAAM,mBAAsB,GAAA,SAAA,CAAA;AAYrB,SAAS,oBACd,MACsC,EAAA;AACtC,EAAA,MAAM,kBAAkB,MAAO,CAAA,iBAAA;AAAA,IAC7B,kCAAA;AAAA,GACF,CAAA;AACA,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAI,IAAA,eAAA,CAAgB,GAAI,CAAA,WAAW,CAAG,EAAA;AAEpC,IAAA,OAAO,CAAC,kBAAA,CAAmB,mBAAqB,EAAA,eAAe,CAAC,CAAA,CAAA;AAAA,GAClE;AAEA,EAAA,OAAO,eAAgB,CAAA,IAAA,EAAO,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA;AACtC,IAAM,MAAA,cAAA,GAAiB,eAAgB,CAAA,SAAA,CAAU,EAAE,CAAA,CAAA;AAEnD,IAAO,OAAA,kBAAA,CAAmB,IAAI,cAAc,CAAA,CAAA;AAAA,GAC7C,CAAA,CAAA;AACH,CAAA;AAEA,SAAS,kBAAA,CACP,IACA,MACoC,EAAA;AAxDtC,EAAA,IAAA,EAAA,CAAA;AAyDE,EAAM,MAAA,SAAA,GAAY,MAAO,CAAA,SAAA,CAAU,WAAW,CAAA,CAAA;AAC9C,EAAA,MAAM,WACJ,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,aAAa,MAAtC,IAA2C,GAAA,EAAA,GAAA,oBAAA,CAAA;AAC7C,EAAM,MAAA,iBAAA,GAAoB,MAAO,CAAA,iBAAA,CAAkB,oBAAoB,CAAA,CAAA;AACvE,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,kBAAkB,CAAA,CAAA;AAEnE,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,WAAA;AAAA,IACA,SAAA;AAAA,IACA,OAAS,EAAA;AAAA,MACP,UAAY,EAAA,iBAAA,GACR,aAAc,CAAA,iBAAiB,CAC/B,GAAA,KAAA,CAAA;AAAA,MACJ,QAAU,EAAA,eAAA,GAAkB,aAAc,CAAA,eAAe,CAAI,GAAA,KAAA,CAAA;AAAA,KAC/D;AAAA,GACF,CAAA;AACF,CAAA;AAQA,SAAS,cAAc,OAAyB,EAAA;AAC9C,EAAA,IAAI,eAAkB,GAAA,OAAA,CAAA;AACtB,EAAA,IAAI,CAAC,eAAA,CAAgB,UAAW,CAAA,GAAG,CAAG,EAAA;AACpC,IAAA,eAAA,GAAkB,CAAI,CAAA,EAAA,eAAA,CAAA,CAAA,CAAA;AAAA,GACxB;AACA,EAAA,IAAI,CAAC,eAAA,CAAgB,QAAS,CAAA,GAAG,CAAG,EAAA;AAClC,IAAA,eAAA,GAAkB,CAAG,EAAA,eAAA,CAAA,CAAA,CAAA,CAAA;AAAA,GACvB;AAEA,EAAO,OAAA,IAAI,OAAO,eAAe,CAAA,CAAA;AACnC;;ACrDA,MAAM,cAAiB,GAAA,QAAA,CAAA;AAUhB,MAAM,4BAAuD,CAAA;AAAA,EAOlE,OAAO,UACL,CAAA,MAAA,EACA,OAIgC,EAAA;AAChC,IAAM,MAAA,YAAA,GAAeA,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACtD,IAAA,MAAMC,aAAc,GAAA,YAAA,CAAa,cAAe,CAAA,MAAA,CAAO,eAAe,CAAA,CAAA;AACtE,IAAA,IAAI,CAACA,aAAa,EAAA;AAGhB,MAAM,MAAA,IAAI,MAAM,4CAA4C,CAAA,CAAA;AAAA,KAC9D;AAEA,IAAO,OAAA,mBAAA,CAAoB,MAAM,CAAE,CAAA,GAAA;AAAA,MACjC,oBACE,IAAI,4BAAA;AAAA,QACF,cAAA;AAAA,QACAA,aAAA;AAAA,QACA,OAAQ,CAAA,MAAA;AAAA,QACR,OAAQ,CAAA,QAAA;AAAA,OACV;AAAA,KACJ,CAAA;AAAA,GACF;AAAA,EAEQ,WACN,CAAA,MAAA,EACA,WACA,EAAA,MAAA,EACA,QACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAS,GAAAC,+CAAA,CAAqB,UAAW,CAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AAChE,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AACD,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,QAAQ,CAAA,CAAA;AAAA,GAClD;AAAA,EAEQ,iBAAiB,QAA2C,EAAA;AAClE,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,MAAA,GAAS,KAAK,SAAU,EAAA,CAAA;AAC9B,MAAA,OAAO,SAAS,GAAI,CAAA;AAAA,QAClB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,4BAA6B,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC1D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAP,EAAA;AACA,YAAA,MAAA,CAAO,MAAM,KAAK,CAAA,CAAA;AAAA,WACpB;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAGA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,wBAAA,EAA2B,KAAK,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,GAChD;AAAA,EAGA,SAAoB,GAAA;AAClB,IAAO,OAAA,CAAA,EAAG,KAAK,eAAgB,EAAA,CAAA,QAAA,CAAA,CAAA;AAAA,GACjC;AAAA,EAGA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,QAAQ,MAAgB,EAAA;AAC5B,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAA,CAAO,KAAK,2DAA2D,CAAA,CAAA;AAEvE,IAAM,MAAA,OAAA,GAAU,MAAM,IAAA,CAAK,gBAAiB,EAAA,CAAA;AAC5C,IAAA,MAAM,QAAW,GAAA,OAAA,CACd,GAAI,CAAA,4BAAA,CAA6B,cAAc,CAC/C,CAAA,GAAA,CAAI,CAAY,QAAA,KAAAC,iDAAA,CAA6B,EAAE,QAAS,EAAC,CAAC,CAAA,CAC1D,IAAI,CAAU,MAAA,KAAA;AACb,MAAO,OAAA;AAAA,QACL,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAA;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAEH,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,aAAa,QAAS,CAAA,MAAA,CAAA,4DAAA,CAAA;AAAA,KACxB,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,gBAAsC,GAAA;AAClD,IAAM,MAAA,SAAA,GAAY,KAAK,MAAO,CAAA,SAAA,CAAA;AAC9B,IAAM,MAAA,WAAA,GAAc,KAAK,MAAO,CAAA,WAAA,CAAA;AAEhC,IAAA,MAAM,kBAAkB,WAAY,CAAA,SAAA;AAAA,MAClC,WAAA,CAAY,WAAY,CAAA,GAAG,CAAI,GAAA,CAAA;AAAA,KACjC,CAAA;AAGA,IAAA,MAAM,MAAS,GAAA;AAAA,MAEb,yBAAA;AAAA,MAEA,gDAAA;AAAA,MACA,4CAAA;AAAA,MACA,qCAAA;AAAA,MAEA,iBAAA;AAAA,MACA,mBAAA;AAAA,MACA,qBAAA;AAAA,MAEA,gDAAA;AAAA,KACF,CAAE,KAAK,GAAG,CAAA,CAAA;AACV,IAAM,MAAA,KAAA,GAAQ,IAAI,eAAyB,CAAA,OAAA,EAAA,WAAA,CAAA,CAAA,CAAA;AAC3C,IAAM,MAAA,aAAA,GAAgB,IAAK,CAAA,MAAA,CACxB,UAAW,CAAA,SAAA,EAAW,OAAO,EAAE,MAAA,EAAQ,CAAA,CACvC,cAAe,EAAA,CAAA;AAElB,IAAA,MAAM,SAAmB,EAAC,CAAA;AAE1B,IAAA,WAAA,MAAiB,gBAAgB,aAAe,EAAA;AAE9C,MAAI,IAAA,YAAA,CAAa,YAAc,CAAA,MAAA,KAAW,CAAG,EAAA;AAC3C,QAAA,SAAA;AAAA,OACF;AAEA,MAAM,MAAA,UAAA,GAAa,YAAa,CAAA,IAAA,CAAM,MAAQ,CAAA,UAAA,CAAA;AAC9C,MAAI,IAAA,IAAA,CAAK,cAAe,CAAA,UAAU,CAAG,EAAA;AACnC,QAAO,MAAA,CAAA,IAAA;AAAA,UACL,4BAA6B,CAAA,KAAA;AAAA,YAC3B,UAAA;AAAA,YACA,aAAa,IAAM,CAAA,IAAA;AAAA,WACrB;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEQ,eAAe,UAAwC,EAAA;AAC7D,IAAM,MAAA,OAAA,GAAU,KAAK,MAAO,CAAA,OAAA,CAAA;AAC5B,IAAA,OACE,CAAC,OACC,IAAA,CAAA,CAAC,QAAQ,UACT,IAAA,OAAA,CAAQ,WAAW,IAAK,CAAA,UAAA,CAAW,QAAS,GAAI,CAAA,MAC/C,CAAC,OAAQ,CAAA,QAAA,IAAY,QAAQ,QAAS,CAAA,IAAA,CAAK,WAAW,IAAK,CAAA,CAAA,CAAA;AAAA,GAElE;AAAA,EAEA,OAAe,KACb,CAAA,UAAA,EACA,QACQ,EAAA;AAjOZ,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAkOI,IAAM,MAAA,OAAA,GAAU,UAAW,CAAA,KAAA,CAAO,IAAM,CAAA,IAAA,CAAA;AACxC,IAAA,MAAM,MAAS,GAAA,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,UAAA,CAAW,UAAX,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAuB,SAAvB,IAA+B,GAAA,EAAA,GAAA,cAAA,CAAA;AAE9C,IAAO,OAAA,CAAA,EAAG,eAAe,MAAU,CAAA,CAAA,EAAA,QAAA,CAAA,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAe,eAAe,MAA8B,EAAA;AAC1D,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAA;AAAA,MACA,QAAU,EAAA,UAAA;AAAA,KACZ,CAAA;AAAA,GACF;AACF;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/BitbucketCloudEntityProviderConfig.ts","../src/BitbucketCloudEntityProvider.ts","../src/service/BitbucketCloudEntityProviderCatalogModule.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 {\n  readTaskScheduleDefinitionFromConfig,\n  TaskScheduleDefinition,\n} from '@backstage/backend-tasks';\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  schedule?: TaskScheduleDefinition;\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  const schedule = config.has('schedule')\n    ? readTaskScheduleDefinitionFromConfig(config.getConfig('schedule'))\n    : undefined;\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    schedule,\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 { PluginTaskScheduler, 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      scheduler?: PluginTaskScheduler;\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    if (!options.schedule && !options.scheduler) {\n      throw new Error('Either schedule or scheduler must be provided.');\n    }\n\n    return readProviderConfigs(config).map(providerConfig => {\n      if (!options.schedule && !providerConfig.schedule) {\n        throw new Error(\n          `No schedule provided neither via code nor config for bitbucketCloud-provider:${providerConfig.id}.`,\n        );\n      }\n\n      const taskRunner =\n        options.schedule ??\n        options.scheduler!.createScheduledTaskRunner(providerConfig.schedule!);\n\n      return new BitbucketCloudEntityProvider(\n        providerConfig,\n        integration,\n        options.logger,\n        taskRunner,\n      );\n    });\n  }\n\n  private constructor(\n    config: BitbucketCloudEntityProviderConfig,\n    integration: BitbucketCloudIntegration,\n    logger: Logger,\n    taskRunner: 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(taskRunner);\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","/*\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 {\n  configServiceRef,\n  createBackendModule,\n  loggerServiceRef,\n  loggerToWinstonLogger,\n  schedulerServiceRef,\n} from '@backstage/backend-plugin-api';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node';\nimport { BitbucketCloudEntityProvider } from '../BitbucketCloudEntityProvider';\n\n/**\n * @alpha\n */\nexport const bitbucketCloudEntityProviderCatalogModule = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'bitbucketCloudEntityProvider',\n  register(env) {\n    env.registerInit({\n      deps: {\n        catalog: catalogProcessingExtensionPoint,\n        config: configServiceRef,\n        logger: loggerServiceRef,\n        scheduler: schedulerServiceRef,\n      },\n      async init({ catalog, config, logger, scheduler }) {\n        const winstonLogger = loggerToWinstonLogger(logger);\n        const providers = BitbucketCloudEntityProvider.fromConfig(config, {\n          logger: winstonLogger,\n          scheduler,\n        });\n\n        catalog.addEntityProvider(providers);\n      },\n    });\n  },\n});\n"],"names":["readTaskScheduleDefinitionFromConfig","ScmIntegrations","integration","BitbucketCloudClient","uuid","locationSpecToLocationEntity","createBackendModule","catalogProcessingExtensionPoint","configServiceRef","loggerServiceRef","schedulerServiceRef","loggerToWinstonLogger"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAsBA,MAAM,oBAAuB,GAAA,oBAAA,CAAA;AAC7B,MAAM,mBAAsB,GAAA,SAAA,CAAA;AAarB,SAAS,oBACd,MACsC,EAAA;AACtC,EAAA,MAAM,kBAAkB,MAAO,CAAA,iBAAA;AAAA,IAC7B,kCAAA;AAAA,GACF,CAAA;AACA,EAAA,IAAI,CAAC,eAAiB,EAAA;AACpB,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAI,IAAA,eAAA,CAAgB,GAAI,CAAA,WAAW,CAAG,EAAA;AAEpC,IAAA,OAAO,CAAC,kBAAA,CAAmB,mBAAqB,EAAA,eAAe,CAAC,CAAA,CAAA;AAAA,GAClE;AAEA,EAAA,OAAO,eAAgB,CAAA,IAAA,EAAO,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA;AACtC,IAAM,MAAA,cAAA,GAAiB,eAAgB,CAAA,SAAA,CAAU,EAAE,CAAA,CAAA;AAEnD,IAAO,OAAA,kBAAA,CAAmB,IAAI,cAAc,CAAA,CAAA;AAAA,GAC7C,CAAA,CAAA;AACH,CAAA;AAEA,SAAS,kBAAA,CACP,IACA,MACoC,EAAA;AA7DtC,EAAA,IAAA,EAAA,CAAA;AA8DE,EAAM,MAAA,SAAA,GAAY,MAAO,CAAA,SAAA,CAAU,WAAW,CAAA,CAAA;AAC9C,EAAA,MAAM,WACJ,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,iBAAkB,CAAA,aAAa,MAAtC,IAA2C,GAAA,EAAA,GAAA,oBAAA,CAAA;AAC7C,EAAM,MAAA,iBAAA,GAAoB,MAAO,CAAA,iBAAA,CAAkB,oBAAoB,CAAA,CAAA;AACvE,EAAM,MAAA,eAAA,GAAkB,MAAO,CAAA,iBAAA,CAAkB,kBAAkB,CAAA,CAAA;AAEnE,EAAM,MAAA,QAAA,GAAW,MAAO,CAAA,GAAA,CAAI,UAAU,CAAA,GAClCA,kDAAqC,MAAO,CAAA,SAAA,CAAU,UAAU,CAAC,CACjE,GAAA,KAAA,CAAA,CAAA;AAEJ,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,WAAA;AAAA,IACA,SAAA;AAAA,IACA,OAAS,EAAA;AAAA,MACP,UAAY,EAAA,iBAAA,GACR,aAAc,CAAA,iBAAiB,CAC/B,GAAA,KAAA,CAAA;AAAA,MACJ,QAAU,EAAA,eAAA,GAAkB,aAAc,CAAA,eAAe,CAAI,GAAA,KAAA,CAAA;AAAA,KAC/D;AAAA,IACA,QAAA;AAAA,GACF,CAAA;AACF,CAAA;AAQA,SAAS,cAAc,OAAyB,EAAA;AAC9C,EAAA,IAAI,eAAkB,GAAA,OAAA,CAAA;AACtB,EAAA,IAAI,CAAC,eAAA,CAAgB,UAAW,CAAA,GAAG,CAAG,EAAA;AACpC,IAAA,eAAA,GAAkB,CAAI,CAAA,EAAA,eAAA,CAAA,CAAA,CAAA;AAAA,GACxB;AACA,EAAA,IAAI,CAAC,eAAA,CAAgB,QAAS,CAAA,GAAG,CAAG,EAAA;AAClC,IAAA,eAAA,GAAkB,CAAG,EAAA,eAAA,CAAA,CAAA,CAAA,CAAA;AAAA,GACvB;AAEA,EAAO,OAAA,IAAI,OAAO,eAAe,CAAA,CAAA;AACnC;;AC/DA,MAAM,cAAiB,GAAA,QAAA,CAAA;AAUhB,MAAM,4BAAuD,CAAA;AAAA,EAOlE,OAAO,UACL,CAAA,MAAA,EACA,OAKgC,EAAA;AAChC,IAAM,MAAA,YAAA,GAAeC,2BAAgB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AACtD,IAAA,MAAMC,aAAc,GAAA,YAAA,CAAa,cAAe,CAAA,MAAA,CAAO,eAAe,CAAA,CAAA;AACtE,IAAA,IAAI,CAACA,aAAa,EAAA;AAGhB,MAAM,MAAA,IAAI,MAAM,4CAA4C,CAAA,CAAA;AAAA,KAC9D;AAEA,IAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,QAAQ,SAAW,EAAA;AAC3C,MAAM,MAAA,IAAI,MAAM,gDAAgD,CAAA,CAAA;AAAA,KAClE;AAEA,IAAA,OAAO,mBAAoB,CAAA,MAAM,CAAE,CAAA,GAAA,CAAI,CAAkB,cAAA,KAAA;AA5E7D,MAAA,IAAA,EAAA,CAAA;AA6EM,MAAA,IAAI,CAAC,OAAA,CAAQ,QAAY,IAAA,CAAC,eAAe,QAAU,EAAA;AACjD,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,gFAAgF,cAAe,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,SACjG,CAAA;AAAA,OACF;AAEA,MAAM,MAAA,UAAA,GAAA,CACJ,aAAQ,QAAR,KAAA,IAAA,GAAA,EAAA,GACA,QAAQ,SAAW,CAAA,yBAAA,CAA0B,eAAe,QAAS,CAAA,CAAA;AAEvE,MAAA,OAAO,IAAI,4BAAA;AAAA,QACT,cAAA;AAAA,QACAA,aAAA;AAAA,QACA,OAAQ,CAAA,MAAA;AAAA,QACR,UAAA;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AAAA,EAEQ,WACN,CAAA,MAAA,EACA,WACA,EAAA,MAAA,EACA,UACA,EAAA;AACA,IAAA,IAAA,CAAK,MAAS,GAAAC,+CAAA,CAAqB,UAAW,CAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AAChE,IAAA,IAAA,CAAK,MAAS,GAAA,MAAA,CAAA;AACd,IAAK,IAAA,CAAA,MAAA,GAAS,OAAO,KAAM,CAAA;AAAA,MACzB,MAAA,EAAQ,KAAK,eAAgB,EAAA;AAAA,KAC9B,CAAA,CAAA;AACD,IAAK,IAAA,CAAA,UAAA,GAAa,IAAK,CAAA,gBAAA,CAAiB,UAAU,CAAA,CAAA;AAAA,GACpD;AAAA,EAEQ,iBAAiB,QAA2C,EAAA;AAClE,IAAA,OAAO,YAAY;AACjB,MAAM,MAAA,MAAA,GAAS,KAAK,SAAU,EAAA,CAAA;AAC9B,MAAA,OAAO,SAAS,GAAI,CAAA;AAAA,QAClB,EAAI,EAAA,MAAA;AAAA,QACJ,IAAI,YAAY;AACd,UAAM,MAAA,MAAA,GAAS,IAAK,CAAA,MAAA,CAAO,KAAM,CAAA;AAAA,YAC/B,KAAA,EAAO,4BAA6B,CAAA,SAAA,CAAU,WAAY,CAAA,IAAA;AAAA,YAC1D,MAAA;AAAA,YACA,cAAA,EAAgBC,gBAAK,EAAG,EAAA;AAAA,WACzB,CAAA,CAAA;AAED,UAAI,IAAA;AACF,YAAM,MAAA,IAAA,CAAK,QAAQ,MAAM,CAAA,CAAA;AAAA,mBAClB,KAAP,EAAA;AACA,YAAA,MAAA,CAAO,MAAM,KAAK,CAAA,CAAA;AAAA,WACpB;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH,CAAA;AAAA,GACF;AAAA,EAGA,eAA0B,GAAA;AACxB,IAAO,OAAA,CAAA,wBAAA,EAA2B,KAAK,MAAO,CAAA,EAAA,CAAA,CAAA,CAAA;AAAA,GAChD;AAAA,EAGA,SAAoB,GAAA;AAClB,IAAO,OAAA,CAAA,EAAG,KAAK,eAAgB,EAAA,CAAA,QAAA,CAAA,CAAA;AAAA,GACjC;AAAA,EAGA,MAAM,QAAQ,UAAqD,EAAA;AACjE,IAAA,IAAA,CAAK,UAAa,GAAA,UAAA,CAAA;AAClB,IAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,QAAQ,MAAgB,EAAA;AAC5B,IAAI,IAAA,CAAC,KAAK,UAAY,EAAA;AACpB,MAAM,MAAA,IAAI,MAAM,iBAAiB,CAAA,CAAA;AAAA,KACnC;AAEA,IAAA,MAAA,CAAO,KAAK,2DAA2D,CAAA,CAAA;AAEvE,IAAM,MAAA,OAAA,GAAU,MAAM,IAAA,CAAK,gBAAiB,EAAA,CAAA;AAC5C,IAAA,MAAM,QAAW,GAAA,OAAA,CACd,GAAI,CAAA,4BAAA,CAA6B,cAAc,CAC/C,CAAA,GAAA,CAAI,CAAY,QAAA,KAAAC,iDAAA,CAA6B,EAAE,QAAS,EAAC,CAAC,CAAA,CAC1D,IAAI,CAAU,MAAA,KAAA;AACb,MAAO,OAAA;AAAA,QACL,WAAA,EAAa,KAAK,eAAgB,EAAA;AAAA,QAClC,MAAA;AAAA,OACF,CAAA;AAAA,KACD,CAAA,CAAA;AAEH,IAAM,MAAA,IAAA,CAAK,WAAW,aAAc,CAAA;AAAA,MAClC,IAAM,EAAA,MAAA;AAAA,MACN,QAAA;AAAA,KACD,CAAA,CAAA;AAED,IAAO,MAAA,CAAA,IAAA;AAAA,MACL,aAAa,QAAS,CAAA,MAAA,CAAA,4DAAA,CAAA;AAAA,KACxB,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,gBAAsC,GAAA;AAClD,IAAM,MAAA,SAAA,GAAY,KAAK,MAAO,CAAA,SAAA,CAAA;AAC9B,IAAM,MAAA,WAAA,GAAc,KAAK,MAAO,CAAA,WAAA,CAAA;AAEhC,IAAA,MAAM,kBAAkB,WAAY,CAAA,SAAA;AAAA,MAClC,WAAA,CAAY,WAAY,CAAA,GAAG,CAAI,GAAA,CAAA;AAAA,KACjC,CAAA;AAGA,IAAA,MAAM,MAAS,GAAA;AAAA,MAEb,yBAAA;AAAA,MAEA,gDAAA;AAAA,MACA,4CAAA;AAAA,MACA,qCAAA;AAAA,MAEA,iBAAA;AAAA,MACA,mBAAA;AAAA,MACA,qBAAA;AAAA,MAEA,gDAAA;AAAA,KACF,CAAE,KAAK,GAAG,CAAA,CAAA;AACV,IAAM,MAAA,KAAA,GAAQ,IAAI,eAAyB,CAAA,OAAA,EAAA,WAAA,CAAA,CAAA,CAAA;AAC3C,IAAM,MAAA,aAAA,GAAgB,IAAK,CAAA,MAAA,CACxB,UAAW,CAAA,SAAA,EAAW,OAAO,EAAE,MAAA,EAAQ,CAAA,CACvC,cAAe,EAAA,CAAA;AAElB,IAAA,MAAM,SAAmB,EAAC,CAAA;AAE1B,IAAA,WAAA,MAAiB,gBAAgB,aAAe,EAAA;AAE9C,MAAI,IAAA,YAAA,CAAa,YAAc,CAAA,MAAA,KAAW,CAAG,EAAA;AAC3C,QAAA,SAAA;AAAA,OACF;AAEA,MAAM,MAAA,UAAA,GAAa,YAAa,CAAA,IAAA,CAAM,MAAQ,CAAA,UAAA,CAAA;AAC9C,MAAI,IAAA,IAAA,CAAK,cAAe,CAAA,UAAU,CAAG,EAAA;AACnC,QAAO,MAAA,CAAA,IAAA;AAAA,UACL,4BAA6B,CAAA,KAAA;AAAA,YAC3B,UAAA;AAAA,YACA,aAAa,IAAM,CAAA,IAAA;AAAA,WACrB;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEQ,eAAe,UAAwC,EAAA;AAC7D,IAAM,MAAA,OAAA,GAAU,KAAK,MAAO,CAAA,OAAA,CAAA;AAC5B,IAAA,OACE,CAAC,OACC,IAAA,CAAA,CAAC,QAAQ,UACT,IAAA,OAAA,CAAQ,WAAW,IAAK,CAAA,UAAA,CAAW,QAAS,GAAI,CAAA,MAC/C,CAAC,OAAQ,CAAA,QAAA,IAAY,QAAQ,QAAS,CAAA,IAAA,CAAK,WAAW,IAAK,CAAA,CAAA,CAAA;AAAA,GAElE;AAAA,EAEA,OAAe,KACb,CAAA,UAAA,EACA,QACQ,EAAA;AA/OZ,IAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAgPI,IAAM,MAAA,OAAA,GAAU,UAAW,CAAA,KAAA,CAAO,IAAM,CAAA,IAAA,CAAA;AACxC,IAAA,MAAM,MAAS,GAAA,CAAA,EAAA,GAAA,CAAA,EAAA,GAAA,UAAA,CAAW,UAAX,KAAA,IAAA,GAAA,KAAA,CAAA,GAAA,EAAA,CAAuB,SAAvB,IAA+B,GAAA,EAAA,GAAA,cAAA,CAAA;AAE9C,IAAO,OAAA,CAAA,EAAG,eAAe,MAAU,CAAA,CAAA,EAAA,QAAA,CAAA,CAAA,CAAA;AAAA,GACrC;AAAA,EAEA,OAAe,eAAe,MAA8B,EAAA;AAC1D,IAAO,OAAA;AAAA,MACL,IAAM,EAAA,KAAA;AAAA,MACN,MAAA;AAAA,MACA,QAAU,EAAA,UAAA;AAAA,KACZ,CAAA;AAAA,GACF;AACF;;AChOO,MAAM,4CAA4CC,oCAAoB,CAAA;AAAA,EAC3E,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,8BAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,iDAAA;AAAA,QACT,MAAQ,EAAAC,iCAAA;AAAA,QACR,MAAQ,EAAAC,iCAAA;AAAA,QACR,SAAW,EAAAC,oCAAA;AAAA,OACb;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,SAAS,MAAQ,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAM,MAAA,aAAA,GAAgBC,uCAAsB,MAAM,CAAA,CAAA;AAClD,QAAM,MAAA,SAAA,GAAY,4BAA6B,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UAChE,MAAQ,EAAA,aAAA;AAAA,UACR,SAAA;AAAA,SACD,CAAA,CAAA;AAED,QAAA,OAAA,CAAQ,kBAAkB,SAAS,CAAA,CAAA;AAAA,OACrC;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;;"}

package/dist/index.d.ts

@@ -1,7 +1,16 @@
-import { TaskRunner } from '@backstage/backend-tasks';
+/**
+ * A Backstage catalog backend module that helps integrate towards Bitbucket Cloud
+ *
+ * @packageDocumentation
+ */
+
+import { BackendFeature } from '@backstage/backend-plugin-api';
 import { Config } from '@backstage/config';
-import { EntityProvider, EntityProviderConnection } from '@backstage/plugin-catalog-backend';
+import { EntityProvider } from '@backstage/plugin-catalog-backend';
+import { EntityProviderConnection } from '@backstage/plugin-catalog-backend';
 import { Logger } from 'winston';
+import { PluginTaskScheduler } from '@backstage/backend-tasks';
+import { TaskRunner } from '@backstage/backend-tasks';
 
 /**
  * Discovers catalog files located in [Bitbucket Cloud](https://bitbucket.org).
@@ -11,7 +20,7 @@ import { Logger } from 'winston';
  *
  * @public
  */
-declare class BitbucketCloudEntityProvider implements EntityProvider {
+export declare class BitbucketCloudEntityProvider implements EntityProvider {
     private readonly client;
     private readonly config;
     private readonly logger;
@@ -19,7 +28,8 @@ declare class BitbucketCloudEntityProvider implements EntityProvider {
     private connection?;
     static fromConfig(config: Config, options: {
         logger: Logger;
-        schedule: TaskRunner;
+        schedule?: TaskRunner;
+        scheduler?: PluginTaskScheduler;
     }): BitbucketCloudEntityProvider[];
     private constructor();
     private createScheduleFn;
@@ -36,4 +46,6 @@ declare class BitbucketCloudEntityProvider implements EntityProvider {
     private static toLocationSpec;
 }
 
-export { BitbucketCloudEntityProvider };
+/* Excluded from this release type: bitbucketCloudEntityProviderCatalogModule */
+
+export { }

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-bitbucket-cloud",
   "description": "A Backstage catalog backend module that helps integrate towards Bitbucket Cloud",
-  "version": "0.1.4-next.1",
+  "version": "0.1.4",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",
+    "alphaTypes": "dist/index.alpha.d.ts",
     "main": "dist/index.cjs.js",
     "types": "dist/index.d.ts"
   },
@@ -23,32 +24,36 @@
     "backstage"
   ],
   "scripts": {
-    "build": "backstage-cli package build",
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build --experimental-type-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"
+    "clean": "backstage-cli package clean"
   },
   "dependencies": {
-    "@backstage/backend-tasks": "^0.3.6-next.1",
-    "@backstage/config": "^1.0.3-next.1",
-    "@backstage/integration": "^1.3.2-next.1",
-    "@backstage/plugin-bitbucket-cloud-common": "^0.2.0-next.1",
-    "@backstage/plugin-catalog-backend": "^1.4.1-next.1",
+    "@backstage/backend-plugin-api": "^0.1.3",
+    "@backstage/backend-tasks": "^0.3.6",
+    "@backstage/config": "^1.0.3",
+    "@backstage/integration": "^1.3.2",
+    "@backstage/plugin-bitbucket-cloud-common": "^0.2.0",
+    "@backstage/plugin-catalog-backend": "^1.5.0",
+    "@backstage/plugin-catalog-node": "^1.2.0",
     "uuid": "^8.0.0",
     "winston": "^3.2.1"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.15.2-next.1",
-    "@backstage/backend-test-utils": "^0.1.29-next.1",
-    "@backstage/cli": "^0.20.0-next.1",
+    "@backstage/backend-common": "^0.15.2",
+    "@backstage/backend-test-utils": "^0.1.29",
+    "@backstage/cli": "^0.20.0",
+    "luxon": "^3.0.0",
     "msw": "^0.47.0"
   },
   "files": [
-    "dist",
-    "config.d.ts"
+    "alpha",
+    "config.d.ts",
+    "dist"
   ],
   "configSchema": "config.d.ts"
 }