Allow configuring authorization

[imolorhe]

Fixes

Checks

• Ran yarn test-build
• Updated relevant documentations
• Updated matching config options in altair-static

Changes proposed in this pull request:

Summary by Sourcery

Allow configuration of initial authorization settings in the Altair GraphQL client, refactor authorization provider inputs for consistency, and update tests and documentation accordingly.

New Features:

• Introduce the ability to configure initial authorization settings in the Altair GraphQL client, allowing users to specify authorization type and data at initialization.

Enhancements:

• Refactor authorization provider inputs to use a more structured format, improving clarity and consistency across different authorization types.

Documentation:

• Update documentation to reflect changes in authorization configuration, including new input structures and initialization options.

Tests:

• Modify existing tests to accommodate changes in authorization input structure, ensuring continued test coverage and accuracy.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR implements configurable authorization by introducing a type-safe authorization system with support for different authorization types (API Key, Basic, Bearer, OAuth2). It adds the ability to configure initial authorization settings through configuration options and updates the authorization providers to use a more structured input format.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Refactored authorization providers to use a standardized input format	Introduced BaseAuthorizationProviderInput interface for consistent provider input structure Updated all authorization providers (API Key, Basic, Bearer, OAuth2) to use typed input interfaces Renamed API Key provider fields from key/value to headerName/headerValue for clarity Created a union type AuthorizationProviderInput to handle all possible authorization types	packages/altair-core/src/authorization/authorization-provider.ts packages/altair-core/src/authorization/providers/api-key.ts packages/altair-core/src/authorization/providers/basic.ts packages/altair-core/src/authorization/providers/bearer.ts packages/altair-core/src/authorization/providers/oauth2.ts packages/altair-core/src/authorization/input.ts
Added support for initial authorization configuration	Added initialAuthorization option to AltairConfigOptions Updated authorization reducer to handle initial authorization settings Added authorization type and data to window export state	packages/altair-core/src/config/options.ts packages/altair-app/src/app/modules/altair/store/authorization/authorization.reducer.ts packages/altair-core/src/types/state/window.interfaces.ts
Added example implementation with Express	Created new Express v4 example with TypeScript configuration Demonstrated initial authorization setup with API Key	examples/express-v4/index.ts examples/express-v4/package.json examples/express-v4/tsconfig.json

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @imolorhe - I've reviewed your changes and they look great!

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

suggestion: Consider improving type safety in AuthorizationProviderExecuteOptions

The type T['data'] assumes data exists, but the parameter is marked as possibly undefined. Consider using T extends BaseAuthorizationProviderInput['data'] for better type safety.

[github-actions]

Visit the preview URL for this PR (updated for commit 69c7ec3):

https://altair-gql--pr2716-imolorhe-allow-confi-6qrbylpv.web.app

_{(expires Sat, 30 Nov 2024 19:22:40 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 02d6323d75a99e532a38922862e269d63351a6cf}