@backstage/plugin-catalog-backend-module-msgraph 0.6.3-next.0 → 0.6.3

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @backstage/plugin-catalog-backend-module-msgraph
 
+## 0.6.3
+
+### Patch Changes
+
+- 4b60e0c: Remove extension points from `/alpha` export, they're available from the main package already
+- 3109c24: The export for the new backend system at the `/alpha` export is now also available via the main entry point, which means that you can remove the `/alpha` suffix from the import.
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.13.1
+  - @backstage/backend-plugin-api@1.0.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/config@1.2.0
+  - @backstage/plugin-catalog-common@1.1.0
+
+## 0.6.3-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-catalog-node@1.13.1-next.1
+  - @backstage/backend-plugin-api@1.0.1-next.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/config@1.2.0
+  - @backstage/plugin-catalog-common@1.1.0
+
 ## 0.6.3-next.0
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/alpha.cjs.js

@@ -2,85 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var backendPluginApi = require('@backstage/backend-plugin-api');
-var alpha = require('@backstage/plugin-catalog-node/alpha');
-var MicrosoftGraphOrgEntityProvider = require('./cjs/MicrosoftGraphOrgEntityProvider-COL3N3sC.cjs.js');
-require('@backstage/plugin-catalog-node');
-require('@azure/identity');
-require('node-fetch');
-require('qs');
-require('lodash');
-require('@backstage/catalog-model');
-require('p-limit');
-require('uuid');
+var catalogModuleMicrosoftGraphOrgEntityProvider = require('./module/catalogModuleMicrosoftGraphOrgEntityProvider.cjs.js');
 
-const microsoftGraphOrgEntityProviderTransformExtensionPoint = backendPluginApi.createExtensionPoint(
-  {
-    id: "catalog.microsoftGraphOrgEntityProvider.transforms"
-  }
-);
-const catalogModuleMicrosoftGraphOrgEntityProvider = backendPluginApi.createBackendModule(
-  {
-    pluginId: "catalog",
-    moduleId: "microsoftGraphOrgEntityProvider",
-    register(env) {
-      let userTransformer;
-      let groupTransformer;
-      let organizationTransformer;
-      let providerConfigTransformer;
-      env.registerExtensionPoint(
-        microsoftGraphOrgEntityProviderTransformExtensionPoint,
-        {
-          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;
-          },
-          setOrganizationTransformer(transformer) {
-            if (organizationTransformer) {
-              throw new Error("Organization transformer may only be set once");
-            }
-            organizationTransformer = transformer;
-          },
-          setProviderConfigTransformer(transformer) {
-            if (providerConfigTransformer) {
-              throw new Error("Provider transformer may only be set once");
-            }
-            providerConfigTransformer = 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 }) {
-          catalog.addEntityProvider(
-            MicrosoftGraphOrgEntityProvider.MicrosoftGraphOrgEntityProvider.fromConfig(config, {
-              logger,
-              scheduler,
-              userTransformer,
-              groupTransformer,
-              organizationTransformer,
-              providerConfigTransformer
-            })
-          );
-        }
-      });
-    }
-  }
-);
+const _feature = catalogModuleMicrosoftGraphOrgEntityProvider.catalogModuleMicrosoftGraphOrgEntityProvider;
 
-exports.default = catalogModuleMicrosoftGraphOrgEntityProvider;
-exports.microsoftGraphOrgEntityProviderTransformExtensionPoint = microsoftGraphOrgEntityProviderTransformExtensionPoint;
+exports.default = _feature;
 //# sourceMappingURL=alpha.cjs.js.map

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/module/catalogModuleMicrosoftGraphOrgEntityProvider.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 { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\nimport {\n  GroupTransformer,\n  OrganizationTransformer,\n  ProviderConfigTransformer,\n  UserTransformer,\n} from '@backstage/plugin-catalog-backend-module-msgraph';\nimport { MicrosoftGraphOrgEntityProvider } from '../processors';\n\n/**\n * Interface for {@link microsoftGraphOrgEntityProviderTransformExtensionPoint}.\n *\n * @alpha\n */\nexport interface MicrosoftGraphOrgEntityProviderTransformsExtensionPoint {\n  /**\n   * Set the function that transforms a user entry in msgraph to an entity.\n   * Optionally, you can pass separate transformers per provider ID.\n   */\n  setUserTransformer(\n    transformer: UserTransformer | Record<string, UserTransformer>,\n  ): void;\n\n  /**\n   * Set the function that transforms a group entry in msgraph to an entity.\n   * Optionally, you can pass separate transformers per provider ID.\n   */\n  setGroupTransformer(\n    transformer: GroupTransformer | Record<string, GroupTransformer>,\n  ): void;\n\n  /**\n   * Set the function that transforms an organization entry in msgraph to an entity.\n   * Optionally, you can pass separate transformers per provider ID.\n   */\n  setOrganizationTransformer(\n    transformer:\n      | OrganizationTransformer\n      | Record<string, OrganizationTransformer>,\n  ): void;\n\n  /**\n   * Set the function that transforms provider config dynamically.\n   * Optionally, you can pass separate transformers per provider ID.\n   * Note: adjusting fields that are not used on each scheduled ingestion\n   *       (e.g., id, schedule) will have no effect.\n   */\n  setProviderConfigTransformer(\n    transformer:\n      | ProviderConfigTransformer\n      | Record<string, ProviderConfigTransformer>,\n  ): void;\n}\n\n/**\n * Extension point used to customize the transforms used by the module.\n *\n * @alpha\n */\nexport const microsoftGraphOrgEntityProviderTransformExtensionPoint =\n  createExtensionPoint<MicrosoftGraphOrgEntityProviderTransformsExtensionPoint>(\n    {\n      id: 'catalog.microsoftGraphOrgEntityProvider.transforms',\n    },\n  );\n\n/**\n * Registers the MicrosoftGraphOrgEntityProvider with the catalog processing extension point.\n *\n * @alpha\n */\nexport const catalogModuleMicrosoftGraphOrgEntityProvider = createBackendModule(\n  {\n    pluginId: 'catalog',\n    moduleId: 'microsoftGraphOrgEntityProvider',\n    register(env) {\n      let userTransformer:\n        | UserTransformer\n        | Record<string, UserTransformer>\n        | undefined;\n      let groupTransformer:\n        | GroupTransformer\n        | Record<string, GroupTransformer>\n        | undefined;\n      let organizationTransformer:\n        | OrganizationTransformer\n        | Record<string, OrganizationTransformer>\n        | undefined;\n      let providerConfigTransformer:\n        | ProviderConfigTransformer\n        | Record<string, ProviderConfigTransformer>\n        | undefined;\n\n      env.registerExtensionPoint(\n        microsoftGraphOrgEntityProviderTransformExtensionPoint,\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          setOrganizationTransformer(transformer) {\n            if (organizationTransformer) {\n              throw new Error('Organization transformer may only be set once');\n            }\n            organizationTransformer = transformer;\n          },\n          setProviderConfigTransformer(transformer) {\n            if (providerConfigTransformer) {\n              throw new Error('Provider transformer may only be set once');\n            }\n            providerConfigTransformer = 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          catalog.addEntityProvider(\n            MicrosoftGraphOrgEntityProvider.fromConfig(config, {\n              logger,\n              scheduler,\n              userTransformer: userTransformer,\n              groupTransformer: groupTransformer,\n              organizationTransformer: organizationTransformer,\n              providerConfigTransformer: providerConfigTransformer,\n            }),\n          );\n        },\n      });\n    },\n  },\n);\n"],"names":["createExtensionPoint","createBackendModule","catalogProcessingExtensionPoint","coreServices","MicrosoftGraphOrgEntityProvider"],"mappings":";;;;;;;;;;;;;;;;AAgFO,MAAM,sDACX,GAAAA,qCAAA;AAAA,EACE;AAAA,IACE,EAAI,EAAA,oDAAA;AAAA,GACN;AACF,EAAA;AAOK,MAAM,4CAA+C,GAAAC,oCAAA;AAAA,EAC1D;AAAA,IACE,QAAU,EAAA,SAAA;AAAA,IACV,QAAU,EAAA,iCAAA;AAAA,IACV,SAAS,GAAK,EAAA;AACZ,MAAI,IAAA,eAAA,CAAA;AAIJ,MAAI,IAAA,gBAAA,CAAA;AAIJ,MAAI,IAAA,uBAAA,CAAA;AAIJ,MAAI,IAAA,yBAAA,CAAA;AAKJ,MAAI,GAAA,CAAA,sBAAA;AAAA,QACF,sDAAA;AAAA,QACA;AAAA,UACE,mBAAmB,WAAa,EAAA;AAC9B,YAAA,IAAI,eAAiB,EAAA;AACnB,cAAM,MAAA,IAAI,MAAM,uCAAuC,CAAA,CAAA;AAAA,aACzD;AACA,YAAkB,eAAA,GAAA,WAAA,CAAA;AAAA,WACpB;AAAA,UACA,oBAAoB,WAAa,EAAA;AAC/B,YAAA,IAAI,gBAAkB,EAAA;AACpB,cAAM,MAAA,IAAI,MAAM,wCAAwC,CAAA,CAAA;AAAA,aAC1D;AACA,YAAmB,gBAAA,GAAA,WAAA,CAAA;AAAA,WACrB;AAAA,UACA,2BAA2B,WAAa,EAAA;AACtC,YAAA,IAAI,uBAAyB,EAAA;AAC3B,cAAM,MAAA,IAAI,MAAM,+CAA+C,CAAA,CAAA;AAAA,aACjE;AACA,YAA0B,uBAAA,GAAA,WAAA,CAAA;AAAA,WAC5B;AAAA,UACA,6BAA6B,WAAa,EAAA;AACxC,YAAA,IAAI,yBAA2B,EAAA;AAC7B,cAAM,MAAA,IAAI,MAAM,2CAA2C,CAAA,CAAA;AAAA,aAC7D;AACA,YAA4B,yBAAA,GAAA,WAAA,CAAA;AAAA,WAC9B;AAAA,SACF;AAAA,OACF,CAAA;AAEA,MAAA,GAAA,CAAI,YAAa,CAAA;AAAA,QACf,IAAM,EAAA;AAAA,UACJ,OAAS,EAAAC,qCAAA;AAAA,UACT,QAAQC,6BAAa,CAAA,UAAA;AAAA,UACrB,QAAQA,6BAAa,CAAA,MAAA;AAAA,UACrB,WAAWA,6BAAa,CAAA,SAAA;AAAA,SAC1B;AAAA,QACA,MAAM,IAAK,CAAA,EAAE,SAAS,MAAQ,EAAA,MAAA,EAAQ,WAAa,EAAA;AACjD,UAAQ,OAAA,CAAA,iBAAA;AAAA,YACNC,+DAAA,CAAgC,WAAW,MAAQ,EAAA;AAAA,cACjD,MAAA;AAAA,cACA,SAAA;AAAA,cACA,eAAA;AAAA,cACA,gBAAA;AAAA,cACA,uBAAA;AAAA,cACA,yBAAA;AAAA,aACD,CAAA;AAAA,WACH,CAAA;AAAA,SACF;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF;AACF;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2023 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { default as feature } from './module';\n\n/** @alpha */\nconst _feature = feature;\nexport default _feature;\n"],"names":["feature"],"mappings":";;;;;;AAmBA,MAAM,QAAW,GAAAA;;;;"}

package/dist/alpha.d.ts

@@ -1,46 +1,6 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { UserTransformer, GroupTransformer, OrganizationTransformer, ProviderConfigTransformer } from '@backstage/plugin-catalog-backend-module-msgraph';
 
-/**
- * Interface for {@link microsoftGraphOrgEntityProviderTransformExtensionPoint}.
- *
- * @alpha
- */
-interface MicrosoftGraphOrgEntityProviderTransformsExtensionPoint {
-    /**
-     * Set the function that transforms a user entry in msgraph to an entity.
-     * Optionally, you can pass separate transformers per provider ID.
-     */
-    setUserTransformer(transformer: UserTransformer | Record<string, UserTransformer>): void;
-    /**
-     * Set the function that transforms a group entry in msgraph to an entity.
-     * Optionally, you can pass separate transformers per provider ID.
-     */
-    setGroupTransformer(transformer: GroupTransformer | Record<string, GroupTransformer>): void;
-    /**
-     * Set the function that transforms an organization entry in msgraph to an entity.
-     * Optionally, you can pass separate transformers per provider ID.
-     */
-    setOrganizationTransformer(transformer: OrganizationTransformer | Record<string, OrganizationTransformer>): void;
-    /**
-     * Set the function that transforms provider config dynamically.
-     * Optionally, you can pass separate transformers per provider ID.
-     * Note: adjusting fields that are not used on each scheduled ingestion
-     *       (e.g., id, schedule) will have no effect.
-     */
-    setProviderConfigTransformer(transformer: ProviderConfigTransformer | Record<string, ProviderConfigTransformer>): void;
-}
-/**
- * Extension point used to customize the transforms used by the module.
- *
- * @alpha
- */
-declare const microsoftGraphOrgEntityProviderTransformExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<MicrosoftGraphOrgEntityProviderTransformsExtensionPoint>;
-/**
- * Registers the MicrosoftGraphOrgEntityProvider with the catalog processing extension point.
- *
- * @alpha
- */
-declare const catalogModuleMicrosoftGraphOrgEntityProvider: _backstage_backend_plugin_api.BackendFeature;
+/** @alpha */
+declare const _feature: _backstage_backend_plugin_api.BackendFeature;
 
-export { type MicrosoftGraphOrgEntityProviderTransformsExtensionPoint, catalogModuleMicrosoftGraphOrgEntityProvider as default, microsoftGraphOrgEntityProviderTransformExtensionPoint };
+export { _feature as default };

package/dist/index.cjs.js

@@ -1,105 +1,34 @@
 'use strict';
 
-var MicrosoftGraphOrgEntityProvider = require('./cjs/MicrosoftGraphOrgEntityProvider-COL3N3sC.cjs.js');
-var pluginCatalogNode = require('@backstage/plugin-catalog-node');
-require('@backstage/catalog-model');
-require('lodash');
-require('uuid');
-require('@azure/identity');
-require('node-fetch');
-require('qs');
-require('@backstage/backend-plugin-api');
-require('p-limit');
+Object.defineProperty(exports, '__esModule', { value: true });
 
-class MicrosoftGraphOrgReaderProcessor {
-  providers;
-  logger;
-  userTransformer;
-  groupTransformer;
-  organizationTransformer;
-  static fromConfig(config, options) {
-    const c = config.getOptionalConfig("catalog.processors.microsoftGraphOrg");
-    return new MicrosoftGraphOrgReaderProcessor({
-      ...options,
-      providers: c ? MicrosoftGraphOrgEntityProvider.readMicrosoftGraphConfig(c) : []
-    });
-  }
-  constructor(options) {
-    options.logger.warn(
-      "MicrosoftGraphOrgReaderProcessor is deprecated. Please use MicrosoftGraphOrgEntityProvider instead. More info at https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-msgraph/CHANGELOG.md#040-next1"
-    );
-    this.providers = options.providers;
-    this.logger = options.logger;
-    this.userTransformer = options.userTransformer;
-    this.groupTransformer = options.groupTransformer;
-    this.organizationTransformer = options.organizationTransformer;
-  }
-  getProcessorName() {
-    return "MicrosoftGraphOrgReaderProcessor";
-  }
-  async readLocation(location, _optional, emit) {
-    if (location.type !== "microsoft-graph-org") {
-      return false;
-    }
-    const provider = this.providers.find(
-      (p) => location.target.startsWith(p.target)
-    );
-    if (!provider) {
-      throw new Error(
-        `There is no Microsoft Graph Org provider that matches ${location.target}. Please add a configuration entry for it under catalog.processors.microsoftGraphOrg.providers.`
-      );
-    }
-    const startTimestamp = Date.now();
-    this.logger.info("Reading Microsoft Graph users and groups");
-    const client = MicrosoftGraphOrgEntityProvider.MicrosoftGraphClient.create(provider);
-    const { users, groups } = await MicrosoftGraphOrgEntityProvider.readMicrosoftGraphOrg(
-      client,
-      provider.tenantId,
-      {
-        userExpand: provider.userExpand,
-        userFilter: provider.userFilter,
-        userSelect: provider.userSelect,
-        loadUserPhotos: provider.loadUserPhotos,
-        userGroupMemberFilter: provider.userGroupMemberFilter,
-        userGroupMemberSearch: provider.userGroupMemberSearch,
-        groupExpand: provider.groupExpand,
-        groupFilter: provider.groupFilter,
-        groupSearch: provider.groupSearch,
-        groupSelect: provider.groupSelect,
-        queryMode: provider.queryMode,
-        userTransformer: this.userTransformer,
-        groupTransformer: this.groupTransformer,
-        organizationTransformer: this.organizationTransformer,
-        logger: this.logger
-      }
-    );
-    const duration = ((Date.now() - startTimestamp) / 1e3).toFixed(1);
-    this.logger.debug(
-      `Read ${users.length} users and ${groups.length} groups from Microsoft Graph in ${duration} seconds`
-    );
-    for (const group of groups) {
-      emit(pluginCatalogNode.processingResult.entity(location, group));
-    }
-    for (const user of users) {
-      emit(pluginCatalogNode.processingResult.entity(location, user));
-    }
-    return true;
-  }
-}
+var catalogModuleMicrosoftGraphOrgEntityProvider = require('./module/catalogModuleMicrosoftGraphOrgEntityProvider.cjs.js');
+var client = require('./microsoftGraph/client.cjs.js');
+var config = require('./microsoftGraph/config.cjs.js');
+var constants = require('./microsoftGraph/constants.cjs.js');
+var helper = require('./microsoftGraph/helper.cjs.js');
+var defaultTransformers = require('./microsoftGraph/defaultTransformers.cjs.js');
+var read = require('./microsoftGraph/read.cjs.js');
+var MicrosoftGraphOrgEntityProvider = require('./processors/MicrosoftGraphOrgEntityProvider.cjs.js');
+var MicrosoftGraphOrgReaderProcessor = require('./processors/MicrosoftGraphOrgReaderProcessor.cjs.js');
 
-exports.MICROSOFT_EMAIL_ANNOTATION = MicrosoftGraphOrgEntityProvider.MICROSOFT_EMAIL_ANNOTATION;
-exports.MICROSOFT_GRAPH_GROUP_ID_ANNOTATION = MicrosoftGraphOrgEntityProvider.MICROSOFT_GRAPH_GROUP_ID_ANNOTATION;
-exports.MICROSOFT_GRAPH_TENANT_ID_ANNOTATION = MicrosoftGraphOrgEntityProvider.MICROSOFT_GRAPH_TENANT_ID_ANNOTATION;
-exports.MICROSOFT_GRAPH_USER_ID_ANNOTATION = MicrosoftGraphOrgEntityProvider.MICROSOFT_GRAPH_USER_ID_ANNOTATION;
-exports.MicrosoftGraphClient = MicrosoftGraphOrgEntityProvider.MicrosoftGraphClient;
+
+
+exports.default = catalogModuleMicrosoftGraphOrgEntityProvider.catalogModuleMicrosoftGraphOrgEntityProvider;
+exports.microsoftGraphOrgEntityProviderTransformExtensionPoint = catalogModuleMicrosoftGraphOrgEntityProvider.microsoftGraphOrgEntityProviderTransformExtensionPoint;
+exports.MicrosoftGraphClient = client.MicrosoftGraphClient;
+exports.readMicrosoftGraphConfig = config.readMicrosoftGraphConfig;
+exports.readProviderConfig = config.readProviderConfig;
+exports.readProviderConfigs = config.readProviderConfigs;
+exports.MICROSOFT_EMAIL_ANNOTATION = constants.MICROSOFT_EMAIL_ANNOTATION;
+exports.MICROSOFT_GRAPH_GROUP_ID_ANNOTATION = constants.MICROSOFT_GRAPH_GROUP_ID_ANNOTATION;
+exports.MICROSOFT_GRAPH_TENANT_ID_ANNOTATION = constants.MICROSOFT_GRAPH_TENANT_ID_ANNOTATION;
+exports.MICROSOFT_GRAPH_USER_ID_ANNOTATION = constants.MICROSOFT_GRAPH_USER_ID_ANNOTATION;
+exports.normalizeEntityName = helper.normalizeEntityName;
+exports.defaultGroupTransformer = defaultTransformers.defaultGroupTransformer;
+exports.defaultOrganizationTransformer = defaultTransformers.defaultOrganizationTransformer;
+exports.defaultUserTransformer = defaultTransformers.defaultUserTransformer;
+exports.readMicrosoftGraphOrg = read.readMicrosoftGraphOrg;
 exports.MicrosoftGraphOrgEntityProvider = MicrosoftGraphOrgEntityProvider.MicrosoftGraphOrgEntityProvider;
-exports.defaultGroupTransformer = MicrosoftGraphOrgEntityProvider.defaultGroupTransformer;
-exports.defaultOrganizationTransformer = MicrosoftGraphOrgEntityProvider.defaultOrganizationTransformer;
-exports.defaultUserTransformer = MicrosoftGraphOrgEntityProvider.defaultUserTransformer;
-exports.normalizeEntityName = MicrosoftGraphOrgEntityProvider.normalizeEntityName;
-exports.readMicrosoftGraphConfig = MicrosoftGraphOrgEntityProvider.readMicrosoftGraphConfig;
-exports.readMicrosoftGraphOrg = MicrosoftGraphOrgEntityProvider.readMicrosoftGraphOrg;
-exports.readProviderConfig = MicrosoftGraphOrgEntityProvider.readProviderConfig;
-exports.readProviderConfigs = MicrosoftGraphOrgEntityProvider.readProviderConfigs;
-exports.MicrosoftGraphOrgReaderProcessor = MicrosoftGraphOrgReaderProcessor;
+exports.MicrosoftGraphOrgReaderProcessor = MicrosoftGraphOrgReaderProcessor.MicrosoftGraphOrgReaderProcessor;
 //# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/processors/MicrosoftGraphOrgReaderProcessor.ts"],"sourcesContent":["/*\n * Copyright 2020 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';\nimport {\n  CatalogProcessor,\n  CatalogProcessorEmit,\n  processingResult,\n} from '@backstage/plugin-catalog-node';\nimport { LocationSpec } from '@backstage/plugin-catalog-common';\nimport {\n  GroupTransformer,\n  MicrosoftGraphClient,\n  MicrosoftGraphProviderConfig,\n  OrganizationTransformer,\n  readMicrosoftGraphConfig,\n  readMicrosoftGraphOrg,\n  UserTransformer,\n} from '../microsoftGraph';\nimport { LoggerService } from '@backstage/backend-plugin-api';\n\n/**\n * Extracts teams and users out of the Microsoft Graph API.\n *\n * @public\n * @deprecated Use the MicrosoftGraphOrgEntityProvider instead.\n */\nexport class MicrosoftGraphOrgReaderProcessor implements CatalogProcessor {\n  private readonly providers: MicrosoftGraphProviderConfig[];\n  private readonly logger: LoggerService;\n  private readonly userTransformer?: UserTransformer;\n  private readonly groupTransformer?: GroupTransformer;\n  private readonly organizationTransformer?: OrganizationTransformer;\n\n  static fromConfig(\n    config: Config,\n    options: {\n      logger: LoggerService;\n      userTransformer?: UserTransformer;\n      groupTransformer?: GroupTransformer;\n      organizationTransformer?: OrganizationTransformer;\n    },\n  ) {\n    const c = config.getOptionalConfig('catalog.processors.microsoftGraphOrg');\n    return new MicrosoftGraphOrgReaderProcessor({\n      ...options,\n      providers: c ? readMicrosoftGraphConfig(c) : [],\n    });\n  }\n\n  constructor(options: {\n    providers: MicrosoftGraphProviderConfig[];\n    logger: LoggerService;\n    userTransformer?: UserTransformer;\n    groupTransformer?: GroupTransformer;\n    organizationTransformer?: OrganizationTransformer;\n  }) {\n    options.logger.warn(\n      'MicrosoftGraphOrgReaderProcessor is deprecated. Please use MicrosoftGraphOrgEntityProvider instead. More info at https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-msgraph/CHANGELOG.md#040-next1',\n    );\n    this.providers = options.providers;\n    this.logger = options.logger;\n    this.userTransformer = options.userTransformer;\n    this.groupTransformer = options.groupTransformer;\n    this.organizationTransformer = options.organizationTransformer;\n  }\n\n  getProcessorName(): string {\n    return 'MicrosoftGraphOrgReaderProcessor';\n  }\n\n  async readLocation(\n    location: LocationSpec,\n    _optional: boolean,\n    emit: CatalogProcessorEmit,\n  ): Promise<boolean> {\n    if (location.type !== 'microsoft-graph-org') {\n      return false;\n    }\n\n    const provider = this.providers.find(p =>\n      location.target.startsWith(p.target),\n    );\n    if (!provider) {\n      throw new Error(\n        `There is no Microsoft Graph Org provider that matches ${location.target}. Please add a configuration entry for it under catalog.processors.microsoftGraphOrg.providers.`,\n      );\n    }\n\n    // Read out all the raw data\n    const startTimestamp = Date.now();\n    this.logger.info('Reading Microsoft Graph users and groups');\n\n    // We create a client each time as we need one that matches the specific provider\n    const client = MicrosoftGraphClient.create(provider);\n    const { users, groups } = await readMicrosoftGraphOrg(\n      client,\n      provider.tenantId,\n      {\n        userExpand: provider.userExpand,\n        userFilter: provider.userFilter,\n        userSelect: provider.userSelect,\n        loadUserPhotos: provider.loadUserPhotos,\n        userGroupMemberFilter: provider.userGroupMemberFilter,\n        userGroupMemberSearch: provider.userGroupMemberSearch,\n        groupExpand: provider.groupExpand,\n        groupFilter: provider.groupFilter,\n        groupSearch: provider.groupSearch,\n        groupSelect: provider.groupSelect,\n        queryMode: provider.queryMode,\n        userTransformer: this.userTransformer,\n        groupTransformer: this.groupTransformer,\n        organizationTransformer: this.organizationTransformer,\n        logger: this.logger,\n      },\n    );\n\n    const duration = ((Date.now() - startTimestamp) / 1000).toFixed(1);\n    this.logger.debug(\n      `Read ${users.length} users and ${groups.length} groups from Microsoft Graph in ${duration} seconds`,\n    );\n\n    // Done!\n    for (const group of groups) {\n      emit(processingResult.entity(location, group));\n    }\n    for (const user of users) {\n      emit(processingResult.entity(location, user));\n    }\n\n    return true;\n  }\n}\n"],"names":["readMicrosoftGraphConfig","MicrosoftGraphClient","readMicrosoftGraphOrg","processingResult"],"mappings":";;;;;;;;;;;;;AAwCO,MAAM,gCAA6D,CAAA;AAAA,EACvD,SAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,eAAA,CAAA;AAAA,EACA,gBAAA,CAAA;AAAA,EACA,uBAAA,CAAA;AAAA,EAEjB,OAAO,UACL,CAAA,MAAA,EACA,OAMA,EAAA;AACA,IAAM,MAAA,CAAA,GAAI,MAAO,CAAA,iBAAA,CAAkB,sCAAsC,CAAA,CAAA;AACzE,IAAA,OAAO,IAAI,gCAAiC,CAAA;AAAA,MAC1C,GAAG,OAAA;AAAA,MACH,SAAW,EAAA,CAAA,GAAIA,wDAAyB,CAAA,CAAC,IAAI,EAAC;AAAA,KAC/C,CAAA,CAAA;AAAA,GACH;AAAA,EAEA,YAAY,OAMT,EAAA;AACD,IAAA,OAAA,CAAQ,MAAO,CAAA,IAAA;AAAA,MACb,mOAAA;AAAA,KACF,CAAA;AACA,IAAA,IAAA,CAAK,YAAY,OAAQ,CAAA,SAAA,CAAA;AACzB,IAAA,IAAA,CAAK,SAAS,OAAQ,CAAA,MAAA,CAAA;AACtB,IAAA,IAAA,CAAK,kBAAkB,OAAQ,CAAA,eAAA,CAAA;AAC/B,IAAA,IAAA,CAAK,mBAAmB,OAAQ,CAAA,gBAAA,CAAA;AAChC,IAAA,IAAA,CAAK,0BAA0B,OAAQ,CAAA,uBAAA,CAAA;AAAA,GACzC;AAAA,EAEA,gBAA2B,GAAA;AACzB,IAAO,OAAA,kCAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,YAAA,CACJ,QACA,EAAA,SAAA,EACA,IACkB,EAAA;AAClB,IAAI,IAAA,QAAA,CAAS,SAAS,qBAAuB,EAAA;AAC3C,MAAO,OAAA,KAAA,CAAA;AAAA,KACT;AAEA,IAAM,MAAA,QAAA,GAAW,KAAK,SAAU,CAAA,IAAA;AAAA,MAAK,CACnC,CAAA,KAAA,QAAA,CAAS,MAAO,CAAA,UAAA,CAAW,EAAE,MAAM,CAAA;AAAA,KACrC,CAAA;AACA,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,sDAAA,EAAyD,SAAS,MAAM,CAAA,+FAAA,CAAA;AAAA,OAC1E,CAAA;AAAA,KACF;AAGA,IAAM,MAAA,cAAA,GAAiB,KAAK,GAAI,EAAA,CAAA;AAChC,IAAK,IAAA,CAAA,MAAA,CAAO,KAAK,0CAA0C,CAAA,CAAA;AAG3D,IAAM,MAAA,MAAA,GAASC,oDAAqB,CAAA,MAAA,CAAO,QAAQ,CAAA,CAAA;AACnD,IAAA,MAAM,EAAE,KAAA,EAAO,MAAO,EAAA,GAAI,MAAMC,qDAAA;AAAA,MAC9B,MAAA;AAAA,MACA,QAAS,CAAA,QAAA;AAAA,MACT;AAAA,QACE,YAAY,QAAS,CAAA,UAAA;AAAA,QACrB,YAAY,QAAS,CAAA,UAAA;AAAA,QACrB,YAAY,QAAS,CAAA,UAAA;AAAA,QACrB,gBAAgB,QAAS,CAAA,cAAA;AAAA,QACzB,uBAAuB,QAAS,CAAA,qBAAA;AAAA,QAChC,uBAAuB,QAAS,CAAA,qBAAA;AAAA,QAChC,aAAa,QAAS,CAAA,WAAA;AAAA,QACtB,aAAa,QAAS,CAAA,WAAA;AAAA,QACtB,aAAa,QAAS,CAAA,WAAA;AAAA,QACtB,aAAa,QAAS,CAAA,WAAA;AAAA,QACtB,WAAW,QAAS,CAAA,SAAA;AAAA,QACpB,iBAAiB,IAAK,CAAA,eAAA;AAAA,QACtB,kBAAkB,IAAK,CAAA,gBAAA;AAAA,QACvB,yBAAyB,IAAK,CAAA,uBAAA;AAAA,QAC9B,QAAQ,IAAK,CAAA,MAAA;AAAA,OACf;AAAA,KACF,CAAA;AAEA,IAAA,MAAM,aAAa,IAAK,CAAA,GAAA,KAAQ,cAAkB,IAAA,GAAA,EAAM,QAAQ,CAAC,CAAA,CAAA;AACjE,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,QAAQ,KAAM,CAAA,MAAM,cAAc,MAAO,CAAA,MAAM,mCAAmC,QAAQ,CAAA,QAAA,CAAA;AAAA,KAC5F,CAAA;AAGA,IAAA,KAAA,MAAW,SAAS,MAAQ,EAAA;AAC1B,MAAA,IAAA,CAAKC,kCAAiB,CAAA,MAAA,CAAO,QAAU,EAAA,KAAK,CAAC,CAAA,CAAA;AAAA,KAC/C;AACA,IAAA,KAAA,MAAW,QAAQ,KAAO,EAAA;AACxB,MAAA,IAAA,CAAKA,kCAAiB,CAAA,MAAA,CAAO,QAAU,EAAA,IAAI,CAAC,CAAA,CAAA;AAAA,KAC9C;AAEA,IAAO,OAAA,IAAA,CAAA;AAAA,GACT;AACF;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -1,12 +1,56 @@
+import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import { SchedulerServiceTaskScheduleDefinition, LoggerService, SchedulerServiceTaskRunner, SchedulerService } from '@backstage/backend-plugin-api';
+import { UserTransformer as UserTransformer$1, GroupTransformer as GroupTransformer$1, OrganizationTransformer as OrganizationTransformer$1, ProviderConfigTransformer as ProviderConfigTransformer$1 } from '@backstage/plugin-catalog-backend-module-msgraph';
 import { TokenCredential } from '@azure/identity';
 import * as MicrosoftGraph from '@microsoft/microsoft-graph-types';
 import { Response } from 'node-fetch';
-import { SchedulerServiceTaskScheduleDefinition, LoggerService, SchedulerServiceTaskRunner, SchedulerService } from '@backstage/backend-plugin-api';
 import { Config } from '@backstage/config';
 import { GroupEntity, UserEntity } from '@backstage/catalog-model';
 import { EntityProvider, EntityProviderConnection, CatalogProcessor, CatalogProcessorEmit } from '@backstage/plugin-catalog-node';
 import { LocationSpec } from '@backstage/plugin-catalog-common';
 
+/**
+ * Interface for {@link microsoftGraphOrgEntityProviderTransformExtensionPoint}.
+ *
+ * @public
+ */
+interface MicrosoftGraphOrgEntityProviderTransformsExtensionPoint {
+    /**
+     * Set the function that transforms a user entry in msgraph to an entity.
+     * Optionally, you can pass separate transformers per provider ID.
+     */
+    setUserTransformer(transformer: UserTransformer$1 | Record<string, UserTransformer$1>): void;
+    /**
+     * Set the function that transforms a group entry in msgraph to an entity.
+     * Optionally, you can pass separate transformers per provider ID.
+     */
+    setGroupTransformer(transformer: GroupTransformer$1 | Record<string, GroupTransformer$1>): void;
+    /**
+     * Set the function that transforms an organization entry in msgraph to an entity.
+     * Optionally, you can pass separate transformers per provider ID.
+     */
+    setOrganizationTransformer(transformer: OrganizationTransformer$1 | Record<string, OrganizationTransformer$1>): void;
+    /**
+     * Set the function that transforms provider config dynamically.
+     * Optionally, you can pass separate transformers per provider ID.
+     * Note: adjusting fields that are not used on each scheduled ingestion
+     *       (e.g., id, schedule) will have no effect.
+     */
+    setProviderConfigTransformer(transformer: ProviderConfigTransformer$1 | Record<string, ProviderConfigTransformer$1>): void;
+}
+/**
+ * Extension point used to customize the transforms used by the module.
+ *
+ * @public
+ */
+declare const microsoftGraphOrgEntityProviderTransformExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<MicrosoftGraphOrgEntityProviderTransformsExtensionPoint>;
+/**
+ * Registers the MicrosoftGraphOrgEntityProvider with the catalog processing extension point.
+ *
+ * @public
+ */
+declare const catalogModuleMicrosoftGraphOrgEntityProvider: _backstage_backend_plugin_api.BackendFeature;
+
 /**
  * The configuration parameters for a single Microsoft Graph provider.
  *
@@ -314,7 +358,7 @@ declare class MicrosoftGraphClient {
      * from Graph API
      *
      * @param entityName - type of parent resource, either `User` or `Group`
-     * @param id - The unique identifier for the {@link entityName | entityName} resource
+     * @param id - The unique identifier for the `entityName` resource
      * @param maxSize - Maximum pixel height of the photo
      *
      */
@@ -602,4 +646,4 @@ declare class MicrosoftGraphOrgReaderProcessor implements CatalogProcessor {
     readLocation(location: LocationSpec, _optional: boolean, emit: CatalogProcessorEmit): Promise<boolean>;
 }
 
-export { type GroupMember, type GroupTransformer, MICROSOFT_EMAIL_ANNOTATION, MICROSOFT_GRAPH_GROUP_ID_ANNOTATION, MICROSOFT_GRAPH_TENANT_ID_ANNOTATION, MICROSOFT_GRAPH_USER_ID_ANNOTATION, MicrosoftGraphClient, MicrosoftGraphOrgEntityProvider, type MicrosoftGraphOrgEntityProviderLegacyOptions, type MicrosoftGraphOrgEntityProviderOptions, MicrosoftGraphOrgReaderProcessor, type MicrosoftGraphProviderConfig, type ODataQuery, type OrganizationTransformer, type ProviderConfigTransformer, type UserTransformer, defaultGroupTransformer, defaultOrganizationTransformer, defaultUserTransformer, normalizeEntityName, readMicrosoftGraphConfig, readMicrosoftGraphOrg, readProviderConfig, readProviderConfigs };
+export { type GroupMember, type GroupTransformer, MICROSOFT_EMAIL_ANNOTATION, MICROSOFT_GRAPH_GROUP_ID_ANNOTATION, MICROSOFT_GRAPH_TENANT_ID_ANNOTATION, MICROSOFT_GRAPH_USER_ID_ANNOTATION, MicrosoftGraphClient, MicrosoftGraphOrgEntityProvider, type MicrosoftGraphOrgEntityProviderLegacyOptions, type MicrosoftGraphOrgEntityProviderOptions, type MicrosoftGraphOrgEntityProviderTransformsExtensionPoint, MicrosoftGraphOrgReaderProcessor, type MicrosoftGraphProviderConfig, type ODataQuery, type OrganizationTransformer, type ProviderConfigTransformer, type UserTransformer, catalogModuleMicrosoftGraphOrgEntityProvider as default, defaultGroupTransformer, defaultOrganizationTransformer, defaultUserTransformer, microsoftGraphOrgEntityProviderTransformExtensionPoint, normalizeEntityName, readMicrosoftGraphConfig, readMicrosoftGraphOrg, readProviderConfig, readProviderConfigs };