@backstage/plugin-catalog-backend-module-github-org 0.1.0-next.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# @backstage/plugin-catalog-backend-module-github-org
+
+## 0.1.0-next.0
+
+### Minor Changes
+
+- c101e683d5: Added `catalogModuleGithubOrgEntityProvider` to ingest users and teams from multiple Github organizations.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-common@0.19.8-next.2
+  - @backstage/plugin-catalog-backend-module-github@0.4.4-next.2
+  - @backstage/backend-tasks@0.5.11-next.2
+  - @backstage/plugin-catalog-node@1.4.7-next.2
+  - @backstage/backend-plugin-api@0.6.6-next.2
+  - @backstage/config@1.1.1-next.0

package/README.md

@@ -0,0 +1,5 @@
+# @backstage/plugin-catalog-backend-module-github-org
+
+The github-org backend module for the catalog plugin.
+
+_This plugin was created through the Backstage CLI_

package/dist/index.cjs.js

@@ -0,0 +1,85 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendCommon = require('@backstage/backend-common');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var backendTasks = require('@backstage/backend-tasks');
+var pluginCatalogBackendModuleGithub = require('@backstage/plugin-catalog-backend-module-github');
+var alpha = require('@backstage/plugin-catalog-node/alpha');
+
+const githubOrgEntityProviderTransformsExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "catalog.githubOrgEntityProvider"
+});
+const catalogModuleGithubOrgEntityProvider = backendPluginApi.createBackendModule({
+  pluginId: "catalog",
+  moduleId: "githubOrgEntityProvider",
+  register(env) {
+    let userTransformer;
+    let teamTransformer;
+    env.registerExtensionPoint(
+      githubOrgEntityProviderTransformsExtensionPoint,
+      {
+        setUserTransformer(transformer) {
+          if (userTransformer) {
+            throw new Error("User transformer may only be set once");
+          }
+          userTransformer = transformer;
+        },
+        setTeamTransformer(transformer) {
+          if (teamTransformer) {
+            throw new Error("Team transformer may only be set once");
+          }
+          teamTransformer = transformer;
+        }
+      }
+    );
+    env.registerInit({
+      deps: {
+        catalog: alpha.catalogProcessingExtensionPoint,
+        config: backendPluginApi.coreServices.rootConfig,
+        logger: backendPluginApi.coreServices.logger,
+        scheduler: backendPluginApi.coreServices.scheduler
+      },
+      async init({ catalog, config, logger, scheduler }) {
+        for (const definition of readDefinitionsFromConfig(config)) {
+          catalog.addEntityProvider(
+            pluginCatalogBackendModuleGithub.GithubMultiOrgEntityProvider.fromConfig(config, {
+              id: definition.id,
+              githubUrl: definition.githubUrl,
+              orgs: definition.orgs,
+              schedule: scheduler.createScheduledTaskRunner(
+                definition.schedule
+              ),
+              logger: backendCommon.loggerToWinstonLogger(logger),
+              userTransformer,
+              teamTransformer
+            })
+          );
+        }
+      }
+    });
+  }
+});
+function readDefinitionsFromConfig(rootConfig) {
+  const baseKey = "catalog.providers.githubOrg";
+  const baseConfig = rootConfig.getOptional(baseKey);
+  if (!baseConfig) {
+    return [];
+  }
+  const configs = Array.isArray(baseConfig) ? rootConfig.getConfigArray(baseKey) : [rootConfig.getConfig(baseKey)];
+  return configs.map((c) => ({
+    id: c.getString("id"),
+    githubUrl: c.getString("githubUrl"),
+    orgs: c.getOptionalStringArray("orgs"),
+    schedule: backendTasks.readTaskScheduleDefinitionFromConfig(c.getConfig("schedule"))
+  }));
+}
+
+Object.defineProperty(exports, 'GithubMultiOrgEntityProvider', {
+  enumerable: true,
+  get: function () { return pluginCatalogBackendModuleGithub.GithubMultiOrgEntityProvider; }
+});
+exports["default"] = catalogModuleGithubOrgEntityProvider;
+exports.githubOrgEntityProviderTransformsExtensionPoint = githubOrgEntityProviderTransformsExtensionPoint;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/module.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 { loggerToWinstonLogger } from '@backstage/backend-common';\nimport {\n  coreServices,\n  createBackendModule,\n  createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport {\n  readTaskScheduleDefinitionFromConfig,\n  TaskScheduleDefinition,\n} from '@backstage/backend-tasks';\nimport { Config } from '@backstage/config';\nimport {\n  GithubMultiOrgEntityProvider,\n  TeamTransformer,\n  UserTransformer,\n} from '@backstage/plugin-catalog-backend-module-github';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\n\n/**\n * Interface for {@link githubOrgEntityProviderTransformsExtensionPoint}.\n *\n * @public\n */\nexport interface GithubOrgEntityProviderTransformsExtensionPoint {\n  /**\n   * Set a custom transformer for transforming from GitHub users to catalog\n   * entities.\n   */\n  setUserTransformer(transformer: UserTransformer): void;\n\n  /**\n   * Set a custom transformer for transforming from GitHub teams to catalog\n   * entities.\n   */\n  setTeamTransformer(transformer: TeamTransformer): void;\n}\n\n/**\n * Extension point for runtime configuration of catalogModuleGithubOrgEntityProvider.\n *\n * @public\n */\nexport const githubOrgEntityProviderTransformsExtensionPoint =\n  createExtensionPoint<GithubOrgEntityProviderTransformsExtensionPoint>({\n    id: 'catalog.githubOrgEntityProvider',\n  });\n\n/**\n * Registers the `GithubMultiOrgEntityProvider` with the catalog processing extension point.\n *\n * @public\n */\nexport const catalogModuleGithubOrgEntityProvider = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'githubOrgEntityProvider',\n  register(env) {\n    let userTransformer: UserTransformer | undefined;\n    let teamTransformer: TeamTransformer | undefined;\n\n    env.registerExtensionPoint(\n      githubOrgEntityProviderTransformsExtensionPoint,\n      {\n        setUserTransformer(transformer) {\n          if (userTransformer) {\n            throw new Error('User transformer may only be set once');\n          }\n          userTransformer = transformer;\n        },\n        setTeamTransformer(transformer) {\n          if (teamTransformer) {\n            throw new Error('Team transformer may only be set once');\n          }\n          teamTransformer = transformer;\n        },\n      },\n    );\n\n    env.registerInit({\n      deps: {\n        catalog: catalogProcessingExtensionPoint,\n        config: coreServices.rootConfig,\n        logger: coreServices.logger,\n        scheduler: coreServices.scheduler,\n      },\n      async init({ catalog, config, logger, scheduler }) {\n        for (const definition of readDefinitionsFromConfig(config)) {\n          catalog.addEntityProvider(\n            GithubMultiOrgEntityProvider.fromConfig(config, {\n              id: definition.id,\n              githubUrl: definition.githubUrl,\n              orgs: definition.orgs,\n              schedule: scheduler.createScheduledTaskRunner(\n                definition.schedule,\n              ),\n              logger: loggerToWinstonLogger(logger),\n              userTransformer,\n              teamTransformer,\n            }),\n          );\n        }\n      },\n    });\n  },\n});\n\nfunction readDefinitionsFromConfig(rootConfig: Config): Array<{\n  id: string;\n  githubUrl: string;\n  orgs?: string[];\n  schedule: TaskScheduleDefinition;\n}> {\n  const baseKey = 'catalog.providers.githubOrg';\n  const baseConfig = rootConfig.getOptional(baseKey);\n  if (!baseConfig) {\n    return [];\n  }\n\n  const configs = Array.isArray(baseConfig)\n    ? rootConfig.getConfigArray(baseKey)\n    : [rootConfig.getConfig(baseKey)];\n\n  return configs.map(c => ({\n    id: c.getString('id'),\n    githubUrl: c.getString('githubUrl'),\n    orgs: c.getOptionalStringArray('orgs'),\n    schedule: readTaskScheduleDefinitionFromConfig(c.getConfig('schedule')),\n  }));\n}\n"],"names":["createExtensionPoint","createBackendModule","catalogProcessingExtensionPoint","coreServices","GithubMultiOrgEntityProvider","loggerToWinstonLogger","readTaskScheduleDefinitionFromConfig"],"mappings":";;;;;;;;;;AA0DO,MAAM,kDACXA,qCAAsE,CAAA;AAAA,EACpE,EAAI,EAAA,iCAAA;AACN,CAAC,EAAA;AAOI,MAAM,uCAAuCC,oCAAoB,CAAA;AAAA,EACtE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,yBAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,eAAA,CAAA;AACJ,IAAI,IAAA,eAAA,CAAA;AAEJ,IAAI,GAAA,CAAA,sBAAA;AAAA,MACF,+CAAA;AAAA,MACA;AAAA,QACE,mBAAmB,WAAa,EAAA;AAC9B,UAAA,IAAI,eAAiB,EAAA;AACnB,YAAM,MAAA,IAAI,MAAM,uCAAuC,CAAA,CAAA;AAAA,WACzD;AACA,UAAkB,eAAA,GAAA,WAAA,CAAA;AAAA,SACpB;AAAA,QACA,mBAAmB,WAAa,EAAA;AAC9B,UAAA,IAAI,eAAiB,EAAA;AACnB,YAAM,MAAA,IAAI,MAAM,uCAAuC,CAAA,CAAA;AAAA,WACzD;AACA,UAAkB,eAAA,GAAA,WAAA,CAAA;AAAA,SACpB;AAAA,OACF;AAAA,KACF,CAAA;AAEA,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,OAC1B;AAAA,MACA,MAAM,IAAK,CAAA,EAAE,SAAS,MAAQ,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,QAAW,KAAA,MAAA,UAAA,IAAc,yBAA0B,CAAA,MAAM,CAAG,EAAA;AAC1D,UAAQ,OAAA,CAAA,iBAAA;AAAA,YACNC,6DAAA,CAA6B,WAAW,MAAQ,EAAA;AAAA,cAC9C,IAAI,UAAW,CAAA,EAAA;AAAA,cACf,WAAW,UAAW,CAAA,SAAA;AAAA,cACtB,MAAM,UAAW,CAAA,IAAA;AAAA,cACjB,UAAU,SAAU,CAAA,yBAAA;AAAA,gBAClB,UAAW,CAAA,QAAA;AAAA,eACb;AAAA,cACA,MAAA,EAAQC,oCAAsB,MAAM,CAAA;AAAA,cACpC,eAAA;AAAA,cACA,eAAA;AAAA,aACD,CAAA;AAAA,WACH,CAAA;AAAA,SACF;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC,EAAA;AAED,SAAS,0BAA0B,UAKhC,EAAA;AACD,EAAA,MAAM,OAAU,GAAA,6BAAA,CAAA;AAChB,EAAM,MAAA,UAAA,GAAa,UAAW,CAAA,WAAA,CAAY,OAAO,CAAA,CAAA;AACjD,EAAA,IAAI,CAAC,UAAY,EAAA;AACf,IAAA,OAAO,EAAC,CAAA;AAAA,GACV;AAEA,EAAA,MAAM,OAAU,GAAA,KAAA,CAAM,OAAQ,CAAA,UAAU,CACpC,GAAA,UAAA,CAAW,cAAe,CAAA,OAAO,CACjC,GAAA,CAAC,UAAW,CAAA,SAAA,CAAU,OAAO,CAAC,CAAA,CAAA;AAElC,EAAO,OAAA,OAAA,CAAQ,IAAI,CAAM,CAAA,MAAA;AAAA,IACvB,EAAA,EAAI,CAAE,CAAA,SAAA,CAAU,IAAI,CAAA;AAAA,IACpB,SAAA,EAAW,CAAE,CAAA,SAAA,CAAU,WAAW,CAAA;AAAA,IAClC,IAAA,EAAM,CAAE,CAAA,sBAAA,CAAuB,MAAM,CAAA;AAAA,IACrC,QAAU,EAAAC,iDAAA,CAAqC,CAAE,CAAA,SAAA,CAAU,UAAU,CAAC,CAAA;AAAA,GACtE,CAAA,CAAA,CAAA;AACJ;;;;;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { UserTransformer, TeamTransformer } from '@backstage/plugin-catalog-backend-module-github';
+export { GithubMultiOrgEntityProvider, TeamTransformer, UserTransformer } from '@backstage/plugin-catalog-backend-module-github';
+
+/**
+ * Interface for {@link githubOrgEntityProviderTransformsExtensionPoint}.
+ *
+ * @public
+ */
+interface GithubOrgEntityProviderTransformsExtensionPoint {
+    /**
+     * Set a custom transformer for transforming from GitHub users to catalog
+     * entities.
+     */
+    setUserTransformer(transformer: UserTransformer): void;
+    /**
+     * Set a custom transformer for transforming from GitHub teams to catalog
+     * entities.
+     */
+    setTeamTransformer(transformer: TeamTransformer): void;
+}
+/**
+ * Extension point for runtime configuration of catalogModuleGithubOrgEntityProvider.
+ *
+ * @public
+ */
+declare const githubOrgEntityProviderTransformsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<GithubOrgEntityProviderTransformsExtensionPoint>;
+/**
+ * Registers the `GithubMultiOrgEntityProvider` with the catalog processing extension point.
+ *
+ * @public
+ */
+declare const catalogModuleGithubOrgEntityProvider: () => _backstage_backend_plugin_api.BackendFeature;
+
+export { GithubOrgEntityProviderTransformsExtensionPoint, catalogModuleGithubOrgEntityProvider as default, githubOrgEntityProviderTransformsExtensionPoint };

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@backstage/plugin-catalog-backend-module-github-org",
+  "description": "The github-org backend module for the catalog plugin.",
+  "version": "0.1.0-next.0",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin-module"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "^0.19.8-next.2",
+    "@backstage/backend-plugin-api": "^0.6.6-next.2",
+    "@backstage/backend-tasks": "^0.5.11-next.2",
+    "@backstage/config": "^1.1.1-next.0",
+    "@backstage/plugin-catalog-backend-module-github": "^0.4.4-next.2",
+    "@backstage/plugin-catalog-node": "^1.4.7-next.2"
+  },
+  "devDependencies": {
+    "@backstage/backend-test-utils": "^0.2.7-next.2",
+    "@backstage/cli": "^0.23.0-next.2",
+    "luxon": "^3.0.0"
+  },
+  "files": [
+    "dist"
+  ]
+}