@backstage/plugin-catalog-backend-module-gitlab-org 0.2.12-next.0 → 0.2.13-next.0

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @backstage/plugin-catalog-backend-module-gitlab-org
 
+## 0.2.13-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-backend-module-gitlab@0.7.3-next.0
+  - @backstage/backend-plugin-api@1.4.3-next.0
+  - @backstage/plugin-catalog-node@1.18.1-next.0
+  - @backstage/plugin-events-node@0.4.15-next.0
+
+## 0.2.12
+
+### Patch Changes
+
+- d8cb60e: feat: Add gitlabOrgEntityProviderTransformsExtensionPoint for overriding user and group transformers
+- Updated dependencies
+  - @backstage/plugin-catalog-backend-module-gitlab@0.7.2
+  - @backstage/plugin-catalog-node@1.18.0
+  - @backstage/backend-plugin-api@1.4.2
+  - @backstage/plugin-events-node@0.4.14
+
 ## 0.2.12-next.0
 
 ### Patch Changes

package/dist/catalogModuleGitlabOrgDiscoveryEntityProvider.cjs.js

@@ -5,10 +5,32 @@ var pluginCatalogBackendModuleGitlab = require('@backstage/plugin-catalog-backen
 var alpha = require('@backstage/plugin-catalog-node/alpha');
 var pluginEventsNode = require('@backstage/plugin-events-node');
 
+const gitlabOrgEntityProviderTransformsExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "catalog.gitlabOrgEntityProvider"
+});
 const catalogModuleGitlabOrgDiscoveryEntityProvider = backendPluginApi.createBackendModule({
   pluginId: "catalog",
   moduleId: "gitlabOrgDiscoveryEntityProvider",
   register(env) {
+    let userTransformer;
+    let groupTransformer;
+    env.registerExtensionPoint(
+      gitlabOrgEntityProviderTransformsExtensionPoint,
+      {
+        setUserTransformer(transformer) {
+          if (userTransformer) {
+            throw new Error("User transformer may only be set once");
+          }
+          userTransformer = transformer;
+        },
+        setGroupTransformer(transformer) {
+          if (groupTransformer) {
+            throw new Error("Group transformer may only be set once");
+          }
+          groupTransformer = transformer;
+        }
+      }
+    );
     env.registerInit({
       deps: {
         config: backendPluginApi.coreServices.rootConfig,
@@ -21,7 +43,9 @@ const catalogModuleGitlabOrgDiscoveryEntityProvider = backendPluginApi.createBac
         const gitlabOrgDiscoveryEntityProvider = pluginCatalogBackendModuleGitlab.GitlabOrgDiscoveryEntityProvider.fromConfig(config, {
           logger,
           events,
-          scheduler
+          scheduler,
+          userTransformer,
+          groupEntitiesTransformer: groupTransformer
         });
         catalog.addEntityProvider(gitlabOrgDiscoveryEntityProvider);
       }
@@ -30,4 +54,5 @@ const catalogModuleGitlabOrgDiscoveryEntityProvider = backendPluginApi.createBac
 });
 
 exports.catalogModuleGitlabOrgDiscoveryEntityProvider = catalogModuleGitlabOrgDiscoveryEntityProvider;
+exports.gitlabOrgEntityProviderTransformsExtensionPoint = gitlabOrgEntityProviderTransformsExtensionPoint;
 //# sourceMappingURL=catalogModuleGitlabOrgDiscoveryEntityProvider.cjs.js.map

package/dist/catalogModuleGitlabOrgDiscoveryEntityProvider.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"catalogModuleGitlabOrgDiscoveryEntityProvider.cjs.js","sources":["../src/catalogModuleGitlabOrgDiscoveryEntityProvider.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  coreServices,\n  createBackendModule,\n} from '@backstage/backend-plugin-api';\nimport { GitlabOrgDiscoveryEntityProvider } from '@backstage/plugin-catalog-backend-module-gitlab';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\n\n/**\n * Registers the GitlabOrgDiscoveryEntityProvider with the catalog processing extension point.\n *\n * @public\n */\nexport const catalogModuleGitlabOrgDiscoveryEntityProvider =\n  createBackendModule({\n    pluginId: 'catalog',\n    moduleId: 'gitlabOrgDiscoveryEntityProvider',\n    register(env) {\n      env.registerInit({\n        deps: {\n          config: coreServices.rootConfig,\n          catalog: catalogProcessingExtensionPoint,\n          logger: coreServices.logger,\n          scheduler: coreServices.scheduler,\n          events: eventsServiceRef,\n        },\n        async init({ config, catalog, logger, scheduler, events }) {\n          const gitlabOrgDiscoveryEntityProvider =\n            GitlabOrgDiscoveryEntityProvider.fromConfig(config, {\n              logger,\n              events,\n              scheduler,\n            });\n          catalog.addEntityProvider(gitlabOrgDiscoveryEntityProvider);\n        },\n      });\n    },\n  });\n"],"names":["createBackendModule","coreServices","catalogProcessingExtensionPoint","eventsServiceRef","GitlabOrgDiscoveryEntityProvider"],"mappings":";;;;;;;AA6BO,MAAM,gDACXA,oCAAoB,CAAA;AAAA,EAClB,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,kCAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAA,GAAA,CAAI,YAAa,CAAA;AAAA,MACf,IAAM,EAAA;AAAA,QACJ,QAAQC,6BAAa,CAAA,UAAA;AAAA,QACrB,OAAS,EAAAC,qCAAA;AAAA,QACT,QAAQD,6BAAa,CAAA,MAAA;AAAA,QACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,QACxB,MAAQ,EAAAE;AAAA,OACV;AAAA,MACA,MAAM,KAAK,EAAE,MAAA,EAAQ,SAAS,MAAQ,EAAA,SAAA,EAAW,QAAU,EAAA;AACzD,QAAM,MAAA,gCAAA,GACJC,iEAAiC,CAAA,UAAA,CAAW,MAAQ,EAAA;AAAA,UAClD,MAAA;AAAA,UACA,MAAA;AAAA,UACA;AAAA,SACD,CAAA;AACH,QAAA,OAAA,CAAQ,kBAAkB,gCAAgC,CAAA;AAAA;AAC5D,KACD,CAAA;AAAA;AAEL,CAAC;;;;"}
+{"version":3,"file":"catalogModuleGitlabOrgDiscoveryEntityProvider.cjs.js","sources":["../src/catalogModuleGitlabOrgDiscoveryEntityProvider.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  coreServices,\n  createBackendModule,\n  createExtensionPoint,\n} from '@backstage/backend-plugin-api';\nimport {\n  GitlabOrgDiscoveryEntityProvider,\n  UserTransformer,\n  GroupTransformer,\n} from '@backstage/plugin-catalog-backend-module-gitlab';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport { eventsServiceRef } from '@backstage/plugin-events-node';\n\n/**\n * Interface for {@link gitlabOrgEntityProviderTransformsExtensionPoint}.\n *\n * @public\n */\nexport interface GitlabOrgEntityProviderTransformsExtensionPoint {\n  /**\n   * Set a custom transformer for transforming from GitLab users to catalog\n   * entities.\n   */\n  setUserTransformer(transformer: UserTransformer): void;\n\n  /**\n   * Set a custom transformer for transforming from GitLab groups to catalog\n   * entities.\n   */\n  setGroupTransformer(transformer: GroupTransformer): void;\n}\n\n/**\n * Extension point for runtime configuration of GitlabOrgDiscoveryEntityProvider.\n *\n * @public\n */\nexport const gitlabOrgEntityProviderTransformsExtensionPoint =\n  createExtensionPoint<GitlabOrgEntityProviderTransformsExtensionPoint>({\n    id: 'catalog.gitlabOrgEntityProvider',\n  });\n\n/**\n * Registers the GitlabOrgDiscoveryEntityProvider with the catalog processing extension point.\n *\n * @public\n */\nexport const catalogModuleGitlabOrgDiscoveryEntityProvider =\n  createBackendModule({\n    pluginId: 'catalog',\n    moduleId: 'gitlabOrgDiscoveryEntityProvider',\n    register(env) {\n      let userTransformer: UserTransformer | undefined;\n      let groupTransformer: GroupTransformer | undefined;\n\n      env.registerExtensionPoint(\n        gitlabOrgEntityProviderTransformsExtensionPoint,\n        {\n          setUserTransformer(transformer) {\n            if (userTransformer) {\n              throw new Error('User transformer may only be set once');\n            }\n            userTransformer = transformer;\n          },\n          setGroupTransformer(transformer) {\n            if (groupTransformer) {\n              throw new Error('Group transformer may only be set once');\n            }\n            groupTransformer = transformer;\n          },\n        },\n      );\n\n      env.registerInit({\n        deps: {\n          config: coreServices.rootConfig,\n          catalog: catalogProcessingExtensionPoint,\n          logger: coreServices.logger,\n          scheduler: coreServices.scheduler,\n          events: eventsServiceRef,\n        },\n        async init({ config, catalog, logger, scheduler, events }) {\n          const gitlabOrgDiscoveryEntityProvider =\n            GitlabOrgDiscoveryEntityProvider.fromConfig(config, {\n              logger,\n              events,\n              scheduler,\n              userTransformer,\n              groupEntitiesTransformer: groupTransformer,\n            });\n          catalog.addEntityProvider(gitlabOrgDiscoveryEntityProvider);\n        },\n      });\n    },\n  });\n"],"names":["createExtensionPoint","createBackendModule","coreServices","catalogProcessingExtensionPoint","eventsServiceRef","GitlabOrgDiscoveryEntityProvider"],"mappings":";;;;;;;AAqDO,MAAM,kDACXA,qCAAA,CAAsE;AAAA,EACpE,EAAA,EAAI;AACN,CAAC;AAOI,MAAM,gDACXC,oCAAA,CAAoB;AAAA,EAClB,QAAA,EAAU,SAAA;AAAA,EACV,QAAA,EAAU,kCAAA;AAAA,EACV,SAAS,GAAA,EAAK;AACZ,IAAA,IAAI,eAAA;AACJ,IAAA,IAAI,gBAAA;AAEJ,IAAA,GAAA,CAAI,sBAAA;AAAA,MACF,+CAAA;AAAA,MACA;AAAA,QACE,mBAAmB,WAAA,EAAa;AAC9B,UAAA,IAAI,eAAA,EAAiB;AACnB,YAAA,MAAM,IAAI,MAAM,uCAAuC,CAAA;AAAA,UACzD;AACA,UAAA,eAAA,GAAkB,WAAA;AAAA,QACpB,CAAA;AAAA,QACA,oBAAoB,WAAA,EAAa;AAC/B,UAAA,IAAI,gBAAA,EAAkB;AACpB,YAAA,MAAM,IAAI,MAAM,wCAAwC,CAAA;AAAA,UAC1D;AACA,UAAA,gBAAA,GAAmB,WAAA;AAAA,QACrB;AAAA;AACF,KACF;AAEA,IAAA,GAAA,CAAI,YAAA,CAAa;AAAA,MACf,IAAA,EAAM;AAAA,QACJ,QAAQC,6BAAA,CAAa,UAAA;AAAA,QACrB,OAAA,EAASC,qCAAA;AAAA,QACT,QAAQD,6BAAA,CAAa,MAAA;AAAA,QACrB,WAAWA,6BAAA,CAAa,SAAA;AAAA,QACxB,MAAA,EAAQE;AAAA,OACV;AAAA,MACA,MAAM,KAAK,EAAE,MAAA,EAAQ,SAAS,MAAA,EAAQ,SAAA,EAAW,QAAO,EAAG;AACzD,QAAA,MAAM,gCAAA,GACJC,iEAAA,CAAiC,UAAA,CAAW,MAAA,EAAQ;AAAA,UAClD,MAAA;AAAA,UACA,MAAA;AAAA,UACA,SAAA;AAAA,UACA,eAAA;AAAA,UACA,wBAAA,EAA0B;AAAA,SAC3B,CAAA;AACH,QAAA,OAAA,CAAQ,kBAAkB,gCAAgC,CAAA;AAAA,MAC5D;AAAA,KACD,CAAA;AAAA,EACH;AACF,CAAC;;;;;"}

package/dist/index.cjs.js

@@ -7,4 +7,5 @@ var catalogModuleGitlabOrgDiscoveryEntityProvider = require('./catalogModuleGitl
 
 
 exports.default = catalogModuleGitlabOrgDiscoveryEntityProvider.catalogModuleGitlabOrgDiscoveryEntityProvider;
+exports.gitlabOrgEntityProviderTransformsExtensionPoint = catalogModuleGitlabOrgDiscoveryEntityProvider.gitlabOrgEntityProviderTransformsExtensionPoint;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

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

package/dist/index.d.ts

@@ -1,5 +1,29 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { UserTransformer, GroupTransformer } from '@backstage/plugin-catalog-backend-module-gitlab';
 
+/**
+ * Interface for {@link gitlabOrgEntityProviderTransformsExtensionPoint}.
+ *
+ * @public
+ */
+interface GitlabOrgEntityProviderTransformsExtensionPoint {
+    /**
+     * Set a custom transformer for transforming from GitLab users to catalog
+     * entities.
+     */
+    setUserTransformer(transformer: UserTransformer): void;
+    /**
+     * Set a custom transformer for transforming from GitLab groups to catalog
+     * entities.
+     */
+    setGroupTransformer(transformer: GroupTransformer): void;
+}
+/**
+ * Extension point for runtime configuration of GitlabOrgDiscoveryEntityProvider.
+ *
+ * @public
+ */
+declare const gitlabOrgEntityProviderTransformsExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<GitlabOrgEntityProviderTransformsExtensionPoint>;
 /**
  * Registers the GitlabOrgDiscoveryEntityProvider with the catalog processing extension point.
  *
@@ -7,4 +31,4 @@ import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
  */
 declare const catalogModuleGitlabOrgDiscoveryEntityProvider: _backstage_backend_plugin_api.BackendFeature;
 
-export { catalogModuleGitlabOrgDiscoveryEntityProvider as default };
+export { type GitlabOrgEntityProviderTransformsExtensionPoint, catalogModuleGitlabOrgDiscoveryEntityProvider as default, gitlabOrgEntityProviderTransformsExtensionPoint };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-backend-module-gitlab-org",
-  "version": "0.2.12-next.0",
+  "version": "0.2.13-next.0",
   "description": "The gitlab-org backend module for the catalog plugin.",
   "backstage": {
     "role": "backend-plugin-module",
@@ -36,15 +36,15 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.4.2-next.0",
-    "@backstage/plugin-catalog-backend-module-gitlab": "0.7.2-next.0",
-    "@backstage/plugin-catalog-node": "1.18.0-next.0",
-    "@backstage/plugin-events-node": "0.4.14-next.0"
+    "@backstage/backend-plugin-api": "1.4.3-next.0",
+    "@backstage/plugin-catalog-backend-module-gitlab": "0.7.3-next.0",
+    "@backstage/plugin-catalog-node": "1.18.1-next.0",
+    "@backstage/plugin-events-node": "0.4.15-next.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.7.1-next.0",
-    "@backstage/cli": "0.33.2-next.0",
-    "@backstage/plugin-events-backend-test-utils": "0.1.47-next.0",
+    "@backstage/backend-test-utils": "1.9.0-next.1",
+    "@backstage/cli": "0.34.2-next.1",
+    "@backstage/plugin-events-backend-test-utils": "0.1.48-next.0",
     "luxon": "^3.0.0"
   },
   "typesVersions": {