@backstage-community/plugin-catalog-backend-module-keycloak 3.2.1 → 3.2.3

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 ### Dependencies
 
+## 3.2.3
+
+### Patch Changes
+
+- 74902d9: Clean up api report warnings and remove unnecessary files
+
+## 3.2.2
+
+### Patch Changes
+
+- 3c72e65: Update Keycloak metadata to reflect dual maintenance support
+- d3d078b: Updated dependency `@types/lodash` to `4.17.13`.
+
 ## 3.2.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -6,40 +6,51 @@ import { GroupEntity, UserEntity } from '@backstage/catalog-model';
 import GroupRepresentation from '@keycloak/keycloak-admin-client/lib/defs/groupRepresentation';
 import UserRepresentation from '@keycloak/keycloak-admin-client/lib/defs/userRepresentation';
 
+/**
+ * @public
+ */
 interface GroupRepresentationWithParent extends GroupRepresentation {
     parentId?: string;
     parent?: string;
     members?: string[];
 }
+/**
+ * @public
+ */
 interface GroupRepresentationWithParentAndEntity extends GroupRepresentationWithParent {
     entity: GroupEntity;
 }
+/**
+ * @public
+ */
 interface UserRepresentationWithEntity extends UserRepresentation {
     entity: UserEntity;
 }
 /**
- * Customize the ingested User entity
+ * Customize the ingested User entity.
  *
  * @public
  *
- * @param {UserEntity} entity The output of the default parser
- * @param {UserRepresentation} user Keycloak user representation
- * @param {string} realm Realm name
- * @param {GroupRepresentationWithParentAndEntity[]} groups Data about available groups (can be used to create additional relationships)
+ * @param entity - The output of the default parser.
+ * @param user - The Keycloak user representation.
+ * @param realm - The realm name.
+ * @param groups - Data about available groups, which can be used to create additional relationships.
  *
- * @returns {Promise<UserEntity | undefined>} Resolve to a modified `UserEntity` object that will be ingested into the catalog or resolve to `undefined` to reject the entity
+ * @returns A promise resolving to a modified `UserEntity` object to be ingested into the catalog,
+ * or `undefined` to reject the entity.
  */
 type UserTransformer = (entity: UserEntity, user: UserRepresentation, realm: string, groups: GroupRepresentationWithParentAndEntity[]) => Promise<UserEntity | undefined>;
 /**
- * Customize the ingested Group entity
+ * Customize the ingested Group entity.
  *
  * @public
  *
- * @param {GroupEntity} entity The output of the default parser
- * @param {GroupRepresentation} group Keycloak group representation
- * @param {string} realm Realm name
+ * @param entity - The output of the default parser.
+ * @param group - The Keycloak group representation.
+ * @param realm - The realm name.
  *
- * @returns {Promise<GroupEntity | undefined>} Resolve to a modified `GroupEntity` object that will be ingested into the catalog or resolve to `undefined` to reject the entity
+ * @returns A promise resolving to a modified `GroupEntity` object to be ingested into the catalog,
+ * or `undefined` to reject the entity.
  */
 type GroupTransformer = (entity: GroupEntity, group: GroupRepresentation, realm: string) => Promise<GroupEntity | undefined>;
 
@@ -186,9 +197,16 @@ declare class KeycloakOrgEntityProvider implements EntityProvider {
     schedule(taskRunner: SchedulerServiceTaskRunner): void;
 }
 
+/**
+ * @public
+ */
 declare const noopGroupTransformer: GroupTransformer;
+/**
+ * @public
+ */
 declare const noopUserTransformer: UserTransformer;
 /**
+ * @public
  * User transformer that sanitizes .metadata.name from email address to a valid name
  */
 declare const sanitizeEmailTransformer: UserTransformer;
@@ -212,8 +230,8 @@ type KeycloakTransformerExtensionPoint = {
 /**
  * Registers the `KeycloakEntityProvider` with the catalog processing extension point.
  *
- * @alpha
+ * @public
  */
 declare const catalogModuleKeycloakEntityProvider: _backstage_backend_plugin_api.BackendFeature;
 
-export { type GroupRepresentationWithParent, type GroupRepresentationWithParentAndEntity, type GroupTransformer, KeycloakOrgEntityProvider, type KeycloakOrgEntityProviderOptions, type KeycloakTransformerExtensionPoint, type UserRepresentationWithEntity, type UserTransformer, catalogModuleKeycloakEntityProvider as default, keycloakTransformerExtensionPoint, noopGroupTransformer, noopUserTransformer, sanitizeEmailTransformer };
+export { type GroupRepresentationWithParent, type GroupRepresentationWithParentAndEntity, type GroupTransformer, KeycloakOrgEntityProvider, type KeycloakOrgEntityProviderOptions, type KeycloakProviderConfig, type KeycloakTransformerExtensionPoint, type UserRepresentationWithEntity, type UserTransformer, catalogModuleKeycloakEntityProvider as default, keycloakTransformerExtensionPoint, noopGroupTransformer, noopUserTransformer, sanitizeEmailTransformer };

package/dist/lib/transformers.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"transformers.cjs.js","sources":["../../src/lib/transformers.ts"],"sourcesContent":["/*\n * Copyright 2024 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 */\nimport type { GroupTransformer, UserTransformer } from './types';\n\nexport const noopGroupTransformer: GroupTransformer = async (\n  entity,\n  _user,\n  _realm,\n) => entity;\n\nexport const noopUserTransformer: UserTransformer = async (\n  entity,\n  _user,\n  _realm,\n  _groups,\n) => entity;\n\n/**\n * User transformer that sanitizes .metadata.name from email address to a valid name\n */\nexport const sanitizeEmailTransformer: UserTransformer = async (\n  entity,\n  _user,\n  _realm,\n  _groups,\n) => {\n  entity.metadata.name = entity.metadata.name.replace(/[^a-zA-Z0-9]/g, '-');\n  return entity;\n};\n"],"names":[],"mappings":";;AAiBO,MAAM,oBAAyC,GAAA,OACpD,MACA,EAAA,KAAA,EACA,MACG,KAAA,OAAA;AAEE,MAAM,mBAAuC,GAAA,OAClD,MACA,EAAA,KAAA,EACA,QACA,OACG,KAAA,OAAA;AAKE,MAAM,wBAA4C,GAAA,OACvD,MACA,EAAA,KAAA,EACA,QACA,OACG,KAAA;AACH,EAAA,MAAA,CAAO,SAAS,IAAO,GAAA,MAAA,CAAO,SAAS,IAAK,CAAA,OAAA,CAAQ,iBAAiB,GAAG,CAAA,CAAA;AACxE,EAAO,OAAA,MAAA,CAAA;AACT;;;;;;"}
+{"version":3,"file":"transformers.cjs.js","sources":["../../src/lib/transformers.ts"],"sourcesContent":["/*\n * Copyright 2024 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 */\nimport type { GroupTransformer, UserTransformer } from './types';\n\n/**\n * @public\n */\nexport const noopGroupTransformer: GroupTransformer = async (\n  entity,\n  _user,\n  _realm,\n) => entity;\n\n/**\n * @public\n */\nexport const noopUserTransformer: UserTransformer = async (\n  entity,\n  _user,\n  _realm,\n  _groups,\n) => entity;\n\n/**\n * @public\n * User transformer that sanitizes .metadata.name from email address to a valid name\n */\nexport const sanitizeEmailTransformer: UserTransformer = async (\n  entity,\n  _user,\n  _realm,\n  _groups,\n) => {\n  entity.metadata.name = entity.metadata.name.replace(/[^a-zA-Z0-9]/g, '-');\n  return entity;\n};\n"],"names":[],"mappings":";;AAoBO,MAAM,oBAAyC,GAAA,OACpD,MACA,EAAA,KAAA,EACA,MACG,KAAA,OAAA;AAKE,MAAM,mBAAuC,GAAA,OAClD,MACA,EAAA,KAAA,EACA,QACA,OACG,KAAA,OAAA;AAME,MAAM,wBAA4C,GAAA,OACvD,MACA,EAAA,KAAA,EACA,QACA,OACG,KAAA;AACH,EAAA,MAAA,CAAO,SAAS,IAAO,GAAA,MAAA,CAAO,SAAS,IAAK,CAAA,OAAA,CAAQ,iBAAiB,GAAG,CAAA,CAAA;AACxE,EAAO,OAAA,MAAA,CAAA;AACT;;;;;;"}

package/dist/module/catalogModuleKeycloakEntityProvider.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"catalogModuleKeycloakEntityProvider.cjs.js","sources":["../../src/module/catalogModuleKeycloakEntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { InputError } from '@backstage/errors';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\n\nimport { keycloakTransformerExtensionPoint } from '../extensions';\nimport type { GroupTransformer, UserTransformer } from '../lib/types';\nimport { KeycloakOrgEntityProvider } from '../providers';\n\n/**\n * Registers the `KeycloakEntityProvider` with the catalog processing extension point.\n *\n * @alpha\n */\nexport const catalogModuleKeycloakEntityProvider = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'catalog-backend-module-keycloak',\n  register(env) {\n    let userTransformer: UserTransformer | undefined;\n    let groupTransformer: GroupTransformer | undefined;\n\n    env.registerExtensionPoint(keycloakTransformerExtensionPoint, {\n      setUserTransformer(transformer) {\n        if (userTransformer) {\n          throw new InputError('User transformer may only be set once');\n        }\n        userTransformer = transformer;\n      },\n      setGroupTransformer(transformer) {\n        if (groupTransformer) {\n          throw new InputError('Group transformer may only be set once');\n        }\n        groupTransformer = transformer;\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          KeycloakOrgEntityProvider.fromConfig(\n            { config, logger },\n            {\n              scheduler: scheduler,\n              schedule: scheduler.createScheduledTaskRunner({\n                frequency: { minutes: 30 },\n                timeout: { minutes: 3 },\n              }),\n              userTransformer: userTransformer,\n              groupTransformer: groupTransformer,\n            },\n          ),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","keycloakTransformerExtensionPoint","InputError","catalogProcessingExtensionPoint","coreServices","KeycloakOrgEntityProvider"],"mappings":";;;;;;;;AAgCO,MAAM,sCAAsCA,oCAAoB,CAAA;AAAA,EACrE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,iCAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,eAAA,CAAA;AACJ,IAAI,IAAA,gBAAA,CAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuBC,4CAAmC,EAAA;AAAA,MAC5D,mBAAmB,WAAa,EAAA;AAC9B,QAAA,IAAI,eAAiB,EAAA;AACnB,UAAM,MAAA,IAAIC,kBAAW,uCAAuC,CAAA,CAAA;AAAA,SAC9D;AACA,QAAkB,eAAA,GAAA,WAAA,CAAA;AAAA,OACpB;AAAA,MACA,oBAAoB,WAAa,EAAA;AAC/B,QAAA,IAAI,gBAAkB,EAAA;AACpB,UAAM,MAAA,IAAIA,kBAAW,wCAAwC,CAAA,CAAA;AAAA,SAC/D;AACA,QAAmB,gBAAA,GAAA,WAAA,CAAA;AAAA,OACrB;AAAA,KACD,CAAA,CAAA;AACD,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,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACNC,mDAA0B,CAAA,UAAA;AAAA,YACxB,EAAE,QAAQ,MAAO,EAAA;AAAA,YACjB;AAAA,cACE,SAAA;AAAA,cACA,QAAA,EAAU,UAAU,yBAA0B,CAAA;AAAA,gBAC5C,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,gBACzB,OAAA,EAAS,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,eACvB,CAAA;AAAA,cACD,eAAA;AAAA,cACA,gBAAA;AAAA,aACF;AAAA,WACF;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}
+{"version":3,"file":"catalogModuleKeycloakEntityProvider.cjs.js","sources":["../../src/module/catalogModuleKeycloakEntityProvider.ts"],"sourcesContent":["/*\n * Copyright 2024 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 { InputError } from '@backstage/errors';\nimport { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';\n\nimport { keycloakTransformerExtensionPoint } from '../extensions';\nimport type { GroupTransformer, UserTransformer } from '../lib/types';\nimport { KeycloakOrgEntityProvider } from '../providers';\n\n/**\n * Registers the `KeycloakEntityProvider` with the catalog processing extension point.\n *\n * @public\n */\nexport const catalogModuleKeycloakEntityProvider = createBackendModule({\n  pluginId: 'catalog',\n  moduleId: 'catalog-backend-module-keycloak',\n  register(env) {\n    let userTransformer: UserTransformer | undefined;\n    let groupTransformer: GroupTransformer | undefined;\n\n    env.registerExtensionPoint(keycloakTransformerExtensionPoint, {\n      setUserTransformer(transformer) {\n        if (userTransformer) {\n          throw new InputError('User transformer may only be set once');\n        }\n        userTransformer = transformer;\n      },\n      setGroupTransformer(transformer) {\n        if (groupTransformer) {\n          throw new InputError('Group transformer may only be set once');\n        }\n        groupTransformer = transformer;\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          KeycloakOrgEntityProvider.fromConfig(\n            { config, logger },\n            {\n              scheduler: scheduler,\n              schedule: scheduler.createScheduledTaskRunner({\n                frequency: { minutes: 30 },\n                timeout: { minutes: 3 },\n              }),\n              userTransformer: userTransformer,\n              groupTransformer: groupTransformer,\n            },\n          ),\n        );\n      },\n    });\n  },\n});\n"],"names":["createBackendModule","keycloakTransformerExtensionPoint","InputError","catalogProcessingExtensionPoint","coreServices","KeycloakOrgEntityProvider"],"mappings":";;;;;;;;AAgCO,MAAM,sCAAsCA,oCAAoB,CAAA;AAAA,EACrE,QAAU,EAAA,SAAA;AAAA,EACV,QAAU,EAAA,iCAAA;AAAA,EACV,SAAS,GAAK,EAAA;AACZ,IAAI,IAAA,eAAA,CAAA;AACJ,IAAI,IAAA,gBAAA,CAAA;AAEJ,IAAA,GAAA,CAAI,uBAAuBC,4CAAmC,EAAA;AAAA,MAC5D,mBAAmB,WAAa,EAAA;AAC9B,QAAA,IAAI,eAAiB,EAAA;AACnB,UAAM,MAAA,IAAIC,kBAAW,uCAAuC,CAAA,CAAA;AAAA,SAC9D;AACA,QAAkB,eAAA,GAAA,WAAA,CAAA;AAAA,OACpB;AAAA,MACA,oBAAoB,WAAa,EAAA;AAC/B,QAAA,IAAI,gBAAkB,EAAA;AACpB,UAAM,MAAA,IAAIA,kBAAW,wCAAwC,CAAA,CAAA;AAAA,SAC/D;AACA,QAAmB,gBAAA,GAAA,WAAA,CAAA;AAAA,OACrB;AAAA,KACD,CAAA,CAAA;AACD,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,QAAQ,OAAA,CAAA,iBAAA;AAAA,UACNC,mDAA0B,CAAA,UAAA;AAAA,YACxB,EAAE,QAAQ,MAAO,EAAA;AAAA,YACjB;AAAA,cACE,SAAA;AAAA,cACA,QAAA,EAAU,UAAU,yBAA0B,CAAA;AAAA,gBAC5C,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,gBACzB,OAAA,EAAS,EAAE,OAAA,EAAS,CAAE,EAAA;AAAA,eACvB,CAAA;AAAA,cACD,eAAA;AAAA,cACA,gBAAA;AAAA,aACF;AAAA,WACF;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF,CAAC;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage-community/plugin-catalog-backend-module-keycloak",
-  "version": "3.2.1",
+  "version": "3.2.3",
   "description": "A Backend backend plugin for Keycloak",
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
@@ -56,7 +56,7 @@
     "@backstage/config": "1.2.0",
     "@backstage/plugin-catalog-backend": "1.27.1",
     "@spotify/prettier-config": "^15.0.0",
-    "@types/lodash": "4.17.5",
+    "@types/lodash": "4.17.13",
     "@types/uuid": "9.0.8",
     "deepmerge": "4.3.1",
     "prettier": "3.3.3"
@@ -78,6 +78,8 @@
     "lifecycle:active",
     "backstage",
     "plugin",
+    "works-with:rhsso:^7.6",
+    "works-with:keycloak:~18",
     "works-with:rhbk:^24",
     "works-with:keycloak:~24"
   ],