From 98d1154305af29e49ef3661ffdee441ae67622e2 Mon Sep 17 00:00:00 2001 From: Marc Rooding Date: Fri, 3 Nov 2023 10:42:28 +0100 Subject: [PATCH 1/5] expose the function for reading ms graph provider config Signed-off-by: Marc Rooding --- .../src/microsoftGraph/index.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/index.ts b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/index.ts index 37dcffec22..4db3fb69c6 100644 --- a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/index.ts +++ b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/index.ts @@ -16,7 +16,11 @@ export { MicrosoftGraphClient } from './client'; export type { GroupMember, ODataQuery } from './client'; -export { readMicrosoftGraphConfig } from './config'; +export { + readMicrosoftGraphConfig, + readProviderConfigs, + readProviderConfig, +} from './config'; export type { MicrosoftGraphProviderConfig } from './config'; export { MICROSOFT_EMAIL_ANNOTATION, From 224aa6f64c501a6a06b296ac4783ff4dbf3574ae Mon Sep 17 00:00:00 2001 From: Marc Rooding Date: Fri, 3 Nov 2023 11:04:56 +0100 Subject: [PATCH 2/5] chore: add changeset Signed-off-by: Marc Rooding --- .changeset/big-roses-stare.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/big-roses-stare.md diff --git a/.changeset/big-roses-stare.md b/.changeset/big-roses-stare.md new file mode 100644 index 0000000000..442e53522e --- /dev/null +++ b/.changeset/big-roses-stare.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend-module-msgraph': patch +--- + +export the function to read ms graph provider config From 961bdee54242d59f14e2cec2ce22125dd337a0a1 Mon Sep 17 00:00:00 2001 From: Marc Rooding Date: Fri, 3 Nov 2023 11:26:31 +0100 Subject: [PATCH 3/5] chore: update api report Signed-off-by: Marc Rooding --- plugins/catalog-backend-module-msgraph/api-report.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/plugins/catalog-backend-module-msgraph/api-report.md b/plugins/catalog-backend-module-msgraph/api-report.md index 3e4d8d99bc..5a08906c10 100644 --- a/plugins/catalog-backend-module-msgraph/api-report.md +++ b/plugins/catalog-backend-module-msgraph/api-report.md @@ -236,6 +236,17 @@ export function readMicrosoftGraphConfig( config: Config, ): MicrosoftGraphProviderConfig[]; +// @public +export function readProviderConfigs( + config: Config, +): MicrosoftGraphProviderConfig[]; + +// @public +export function readProviderConfig( + id: string, + config: Config, +): MicrosoftGraphProviderConfig; + // @public export function readMicrosoftGraphOrg( client: MicrosoftGraphClient, From 4913addc6531826eee1a6756cef83bb63d3d48b6 Mon Sep 17 00:00:00 2001 From: Marc Rooding Date: Mon, 6 Nov 2023 17:01:09 +0100 Subject: [PATCH 4/5] chore: define API definitions Signed-off-by: Marc Rooding --- .../src/microsoftGraph/config.ts | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/config.ts b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/config.ts index cf4ec646a2..1d9592e96f 100644 --- a/plugins/catalog-backend-module-msgraph/src/microsoftGraph/config.ts +++ b/plugins/catalog-backend-module-msgraph/src/microsoftGraph/config.ts @@ -226,6 +226,13 @@ export function readMicrosoftGraphConfig( return providers; } +/** + * Parses all configured providers. + * + * @param config - The root of the msgraph config hierarchy + * + * @public + */ export function readProviderConfigs( config: Config, ): MicrosoftGraphProviderConfig[] { @@ -248,6 +255,14 @@ export function readProviderConfigs( }); } +/** + * Parses a single configured provider by id. + * + * @param id - the id of the provider to parse + * @param config - The root of the msgraph config hierarchy + * + * @public + */ export function readProviderConfig( id: string, config: Config, From a03524fce58a840d28181068253ae00870f19d06 Mon Sep 17 00:00:00 2001 From: Marc Rooding Date: Mon, 6 Nov 2023 18:06:12 +0100 Subject: [PATCH 5/5] chore: update api-report.md Signed-off-by: Marc Rooding --- .../api-report.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/plugins/catalog-backend-module-msgraph/api-report.md b/plugins/catalog-backend-module-msgraph/api-report.md index 5a08906c10..7f5c4b804c 100644 --- a/plugins/catalog-backend-module-msgraph/api-report.md +++ b/plugins/catalog-backend-module-msgraph/api-report.md @@ -236,17 +236,6 @@ export function readMicrosoftGraphConfig( config: Config, ): MicrosoftGraphProviderConfig[]; -// @public -export function readProviderConfigs( - config: Config, -): MicrosoftGraphProviderConfig[]; - -// @public -export function readProviderConfig( - id: string, - config: Config, -): MicrosoftGraphProviderConfig; - // @public export function readMicrosoftGraphOrg( client: MicrosoftGraphClient, @@ -272,6 +261,17 @@ export function readMicrosoftGraphOrg( groups: GroupEntity[]; }>; +// @public +export function readProviderConfig( + id: string, + config: Config, +): MicrosoftGraphProviderConfig; + +// @public +export function readProviderConfigs( + config: Config, +): MicrosoftGraphProviderConfig[]; + // @public export type UserTransformer = ( user: MicrosoftGraph.User,