feat: Support for Customizable OpenID Profile Fields via Environment Variable

[rubentalstra]

Summary

Closes #4362
#4354

Docs: LibreChat-AI/librechat.ai#205

This Pull Request introduces comprehensive OpenID Connect (OIDC) support. The key changes include:

• Environment Configuration: Updated .env.example to include new environment variables required for OpenID integration.
• User Schema Enhancements: Modified userSchema.js to accommodate additional fields for OpenID data, ensuring seamless user management.
• Data Mappers Implementation: Added openidDataMapper.js with provider-specific data mappers for Microsoft, AWS Cognito and Keycloak to handle custom OpenID data effectively.
• OpenID Strategy Configuration: Enhanced openidStrategy.js to utilize the new data mappers, enforce role-based access control, and manage user avatars based on OpenID data.
• Dependency Updates: Updated package.json and package-lock.json to include necessary libraries for OpenID functionality.
• Type Definitions: Updated TypeScript types in types.ts to support custom OpenID data mappings.

Change Type

• New feature (non-breaking change which adds functionality)
• This change requires a documentation update

Testing

currently only the Microsoft provider tested and full working.

Checklist

• My code adheres to this project's style guidelines
• I have performed a self-review of my own code
• I have commented in any complex areas of my code
• I have made pertinent documentation changes
• My changes do not introduce new warnings
• I have written tests demonstrating that my changes are effective or that my feature works
• Local unit tests pass with my changes
• A pull request for updating the documentation has been submitted.

[rubentalstra]

@danny-avila i read your comment on a different pull request regarding a generic method for determining custom data from different openID providers.

Is this going in the right direction? I would love to get some feedback to contribute to this amazing project.

[danny-avila]

I'm hesitant to make drastic changes here since a lot of people depend on OpenID for Authentication. If you could introduce this with the least amount of changes, adhering to the original code as much as possible, that would be appreciated. The smallest of changes have caused headaches in this module before and I wish to avoid that.

Also I noticed you wrote "// Not Tested"

You shouldn't introduce code you aren't testing, rather focus on what does work and introduce it non-intrusively.

Lastly, any new methods and functions, I would recommend introducing in another module other than api/strategies/openidStrategy.js

[rubentalstra]

thank you for the feedback. I will for sure simplify it and make as less changes as possible. then I will only add the option first of microsoft graph api.

[rubentalstra]

closed because of new pull request: #5612