chore: update docs and correct authentication payload types#15
Merged
chore: update docs and correct authentication payload types#15
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR simplifies the authentication API by removing the mode parameter and associated types (AuthMode, AuthPayload, AuthCredentials). The authentication now directly uses KeycloakTokenResponse from the identity provider without requiring an additional mode field. The PR also standardizes quote style to single quotes across type definitions.
Changes:
- Removed
AuthMode,AuthPayload, andAuthCredentialstypes, replacing them with direct use ofKeycloakTokenResponse - Updated all authentication-related code, tests, and documentation to remove the
modefield - Standardized string literal quotes from double to single quotes in type definition files
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/types/protocol.ts | Removed AuthMode type definition and converted quotes to single quotes for consistency |
| src/types/payloads.ts | Removed AuthPayload interface that extended KeycloakTokenResponse with mode field; standardized quotes |
| src/types/api.ts | Removed AuthCredentials type alias and updated auth() signature to use KeycloakTokenResponse |
| src/CortiEmbedded.ts | Updated auth() method signature and removed mode field from payload construction |
| src/utils/PostMessageHandler.ts | Updated auth() method signature to accept KeycloakTokenResponse |
| test/corti-embedded.test.ts | Updated test credentials to use KeycloakTokenResponse and removed mode field from test data |
| demo/demo.ts | Updated type imports and removed type assertion for auth payload parsing |
| docs/react-usage.md | Removed mode field from authentication example |
| README.md | Updated authentication documentation to remove references to mode field |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
filipweilid
approved these changes
Mar 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.